Cuenta

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

POST /account/
Cuerpo de la solicitud
Respuestas
GET /account/accountByName
Parámetros
Respuestas
POST /account/bulkUpdateActiveInactive
Cuerpo de la Solicitud
Respuestas
POST /account/filter
Cuerpo de la Solicitud
Respuestas
POST /account/listByAccountId
Cuerpo de la Solicitud
Respuestas
GET /account/{id}
Parámetros
Respuestas
PUT /account/{id}
Parámetros
Cuerpo de la solicitud
Respuestas
DELETE /account/{id}
Parámetros
Respuestas
GET /account/{parentAccountId}/customer
Parámetros
Respuestas
GET /account/{parentAccountId}/sites/information
Parámetros
Respuestas
GET /account/{parentAccountId}/users
Parámetros
Respuestas

Operaciones sobre recursos de cuenta. 11 endpoints, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Authentication.

POST /account/

Crear nuevas cuentas

Cuerpo de la solicitud

Añadir Cuenta

json

{
  "payload": {
    "id": "string",
    "name": "string (required)",
    "email": "string (required)",
    "firstName": "string",
    "lastName": "string",
    "isActive": "boolean",
    "profileVisible": "boolean",
    "countryCode": "string",
    "phoneNumber": "string",
    "houseBuildingNumber": "string",
    "streetName": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "code": "string",
    "logo": "string",
    "latitude": "string",
    "longitude": "string",
    "plusCode": "string",
    "what3Words": "string",
    "business": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "photos": [
      "string"
    ],
    "devImage": "string",
    "followers": [
      "string"
    ],
    "accountType": [
      "Customer"
    ],
    "websiteUrl": "string",
    "jsonSchema": "object",
    "parentJsonSchemaResult": "object",
    "parentAccountId": "string",
    "parent": "string",
    "serviceProvidersEventProviderId": "string",
    "roles": [
      "string"
    ],
    "geoCordinates": "object"
  }
}

Respuestas

Estado	Descripción	Cuerpo
200	Success
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Forbidden

GET /account/accountByName

Obtener cuenta por nombre

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
nombre	consulta	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

POST /account/bulkUpdateActiveInactive

actualización masiva de sps por id de cuenta padre

Cuerpo de la Solicitud

Actualizar SPs

json

{
  "parentAccountId": "string"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "data": [
    {
      "key": "7f01237864567eba89736f825",
      "label": "customer",
      "serviceProviderName": "sp"
    }
  ]
}

POST /account/filter

Obtiene la lista de cuentas con filtrado, ordenación y paginación. Permite la búsqueda por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario conectado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.

Cuerpo de la Solicitud

Filtrado y ordenación de cuentas

json

{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "config": {
    "columns": [
      {
        "visibility": true,
        "columnName": "commercialName",
        "DisplayName": "Account",
        "isFilterable": true,
        "filterType": "stringCondition",
        "sticky": true,
        "isRightBorder": true,
        "isMandatory": true,
        "isNotDraggable": true
      }
    ],
    "defaultNPerPage": 50,
    "defaultFilterCondition": [],
    "defaultSortingOrder": [
      {
        "columnName": "dateTime",
        "isAscending": false
      }
    ],
    "maxVisibleColumnCount": 6,
    "exportLimitNPerPage": 500
  },
  "dataResult": [
    {
      "name": "app",
      "email": "app@test.com",
      "isActive": "true",
      "phoneNumber": "",
      "streetName": "",
      "city": "",
      "code": "",
      "uniqueId": "da7cf69b4c714f80d8466c714f683a8173cdb",
      "parentAccountId": "acf9b10a2c714f683a8173cdb7f417cf4a4"
    },
    {
      "name": "Customer",
      "email": "customer@test.com",
      "isActive": "true",
      "phoneNumber": "",
      "streetName": "",
      "city": "",
      "code": "",
      "uniqueId": "c714f683a8173cdb58acf9b10a7cf69b",
      "parentAccountId": "acf9b10a2c714f683a8173cdb7f417cf4a4"
    }
  ],
  "totalRecordsCount": 3552,
  "filteredBy": [],
  "sortedBy": [
    {
      "columnName": "dateTime",
      "isAscending": false
    }
  ],
  "dispatchedAll": false,
  "isDefaultProjectionMutated": false,
  "isDefaultFilterMutated": false,
  "isDefaultSortingMutated": false
}

POST /account/listByAccountId

Obtener clientes por ID de cuenta padre

Cuerpo de la Solicitud

Obtener clientes

json

{
  "parentAccountId": "string"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "data": [
    {
      "key": "7f01237864567eba89736f825",
      "label": "customer",
      "serviceProviderName": "sp"
    }
  ]
}

GET /account/{id}

Obtener cuenta por Id

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

PUT /account/{id}

Actualizar cuentas existentes

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	path	cadena	sí

Cuerpo de la solicitud

Para añadir o actualizar una cuenta, proporcione el Id existente

json

{
  "payload": {
    "id": "string",
    "uniqueId": "string",
    "parent": "string",
    "parentAccountId": "string",
    "email": "string (required)",
    "isActive": "boolean",
    "persona": {
      "address": {
        "houseBuildingNumber": "string",
        "streetName": "string",
        "city": "string",
        "state": "string",
        "code": "string",
        "country": "string"
      },
      "contact": {
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "profile": {
        "logo": "string",
        "business": [
          "…"
        ],
        "photos": [
          "…"
        ],
        "tags": [
          "…"
        ],
        "followers": [
          "…"
        ],
        "s3ImagePath": "string"
      }
    },
    "accountType": [
      "Customer"
    ],
    "name": "string (required)",
    "profileVisible": "boolean",
    "syncStatus": "boolean",
    "jsonSchema": "object",
    "geoCordinates": "object",
    "serviceProvidersEventProviderId": "string"
  }
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

DELETE /account/{id}

Eliminar una cuenta por Id

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

GET /account/{parentAccountId}/customer

Obtener lista de clientes por ID padre (ID del cliente)

Parámetros

Nombre	En	Tipo	Requerido	Descripción
parentAccountId	path	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

GET /account/{parentAccountId}/sites/information

Obtener lista de sitios por id padre (Identificación del cliente)

Parámetros

Nombre	En	Tipo	Requerido	Descripción
parentAccountId	path	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

GET /account/{parentAccountId}/users

Obtener lista de usuarios por id de padre (Identificación del cliente)

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
parentAccountId	path	string	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.