Usuarios

Listar Usuarios

GET /v2/users

Parámetro	Descripción
attributes	Especifica qué atributos recuperar. Puede incluir valores como 'serial', 'number', 'carrier', 'service_provider' y 'batch'. Si es nulo, recupera toda la información.
includes	Especifica entidades relacionadas para incluir en la consulta. Contiene matrices para 'device' y 'enterprise' con valores como 'name', 'imei', 'code', 'cnpj'.
filters	Especifica filtros para varios campos como 'chips.serial', 'chips.number', 'device.name', etc. Cada campo de filtro soporta condiciones como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica la consulta de búsqueda como mucho 100 caracteres.
limit	Especifica el número máximo de resultados a ser devuelto. Debe ser un número entre 1 y 100.
page	Especifica el número de página para resultados paginados. Debe ser un número mayor o igual a 0.
count	Indica si incluir el recuento total de resultados en la respuesta.
sort	Especifica criterios de ordenación para los campos 'number' y 'serial'. Los valores pueden ser -1 (orden descendente) o 1 (orden ascendente).

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta Estándar
400	Bad Request	Solicitud Inválida

Esta operación no requiere autenticación

Crear Usuario

POST /v2/users

{
  "body": {
    "data": {
      "attributes": {
        "username": "john_doe",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone1": "+1234567890",
        "phone2": "+9876543210",
        "emergency_contact": "Jane Doe",
        "emergency_phone": "+1112223333",
        "document_number": "12345678901",
        "cpf": "98765432109",
        "birthdate": "1990-05-15",
        "locale": "en_US"
      },
      "relationships": {
        "enterprise": {
          "type": "enterprise",
          "id": "abc123def456ghi"
        },
        "roles": {
          "type": "roles",
          "id": "role123"
        }
      }
    }
  }
}

Campo	Descripción	Obrigatório
data	Objeto	sí
attributes	Objeto que contiene atributos de datos del usuario.	sí
- username	String con el nombre de usuario del usuario, sin espacios, con una longitud entre 1 y 255 caracteres.	sí
- email	String con la dirección de correo electrónico del usuario, validada como un formato de correo electrónico.	sí
- name	String con el nombre del usuario, como mucho 255 caracteres.	sí
- phone1	String con el número de teléfono principal del usuario, como mucho 20 caracteres.	no
- phone2	String con el número de teléfono secundario del usuario, como mucho 20 caracteres.	no
- emergency_contact	String con la información de contacto de emergencia del usuario, como mucho 255 caracteres.	no
- emergency_phone	String con el número de teléfono de emergencia del usuario, como mucho 20 caracteres.	no
- document_number	String con el número de documento del usuario, como mucho 20 caracteres.	no
- cpf	String con el CPF del usuario, sin espacios, con una longitud entre 1 y 20 caracteres.	sí
- birthdate	Fecha de nacimiento del usuario.	no
- locale	String con la localidad del usuario, debe ser una de las opciones 'pt_BR', 'es_UY' o 'en_US'.	sí
relationships	Objeto que contiene datos de relación.	sí
- enterprise	Objeto que representa la relación con una empresa.	sí
-- type	String con el tipo de relación, debe ser 'enterprise'.	sí
-- id	String con el ID de la empresa, debe consistir en 15 caracteres alfanuméricos.	sí
- roles	Objeto que representa la relación con funciones.	no
-- type	String con el tipo de relación, debe ser 'roles'.	sí
-- id	String con el ID de las funciones, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta Estándar
400	Bad Request	Uno de 'Bad Request', 'Entity Duplicated' o 'Can Not Create Multiple Users For Different Enterprises'

Esta operación no requiere autenticación

Mostrar Usuario

GET /v2/users/{id}

Campo	Descripción
attributes	Array de atributos para recuperar. Puede contener valores como 'username', 'email', 'name', etc. Si es nulo, se recuperan todos los datos.
includes	Especifica entidades relacionadas para incluir en la consulta. Contiene matrices para 'addresses', 'document', y 'enterprise', que pueden incluir valores como 'formatted_address', 'city', 'name', etc.
- addresses	Array de atributos de dirección para incluir. Puede contener valores como 'formatted_address', 'city', 'region', 'zip_code'.
- document	Array de atributos de documento para incluir. Puede contener valores como 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'.
- enterprise	Array de atributos de empresa para incluir. Puede contener valores como 'name', 'cnpj'.

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta Estándar
400	Bad Request	Solicitud Inválida
401	Unauthorized	No Autorizado
404	Not Found	No Encontrado

Esta operación no requiere autenticación

Actualizar Usuario

PATCH /v2/users/{id}

Datos de Envío

{
  "body": {
    "data": {
      "attributes": {
        "username": "john_doe",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone1": "+1234567890",
        "phone2": "+9876543210",
        "emergency_contact": "Jane Doe",
        "emergency_phone": "+1112223333",
        "document_number": "12345678901",
        "cpf": "98765432109",
        "birthdate": "1990-05-15",
        "locale": "en_US"
      },
      "relationships": {
        "enterprise": {
          "type": "enterprise",
          "id": "abc123def456ghi"
        },
        "roles": {
          "type": "roles",
          "id": "role123"
        }
      }
    }
  }
}

Campo	Descripción	Obrigatório
data	Objeto	sí
attributes	Objeto que contiene atributos de datos del usuario.	sí
- username	String con el nombre de usuario del usuario, sin espacios, con una longitud entre 1 y 255 caracteres.	sí
- email	String con la dirección de correo electrónico del usuario, validada como un formato de correo electrónico.	sí
- name	String con el nombre del usuario, como mucho 255 caracteres.	sí
- phone1	String con el número de teléfono principal del usuario, como mucho 20 caracteres.	no
- phone2	String con el número de teléfono secundario del usuario, como mucho 20 caracteres.	no
- emergency_contact	String con la información de contacto de emergencia del usuario, como mucho 255 caracteres.	no
- emergency_phone	String con el número de teléfono de emergencia del usuario, como mucho 20 caracteres.	no
- document_number	String con el número de documento del usuario, como mucho 20 caracteres.	no
- cpf	String con el CPF del usuario, sin espacios, con una longitud entre 1 y 20 caracteres.	sí
- birthdate	Fecha de nacimiento del usuario.	no
- locale	String con la localidad del usuario, debe ser una de las opciones 'pt_BR', 'es_UY' o 'en_US'.	sí
relationships	Objeto que contiene datos de relación.	sí
- enterprise	Objeto que representa la relación con una empresa.	sí
-- type	String con el tipo de relación, debe ser 'enterprise'.	sí
-- id	String con el ID de la empresa, debe consistir en 15 caracteres alfanuméricos.	sí
- roles	Objeto que representa la relación con funciones.	no
-- type	String con el tipo de relación, debe ser 'roles'.	sí
-- id	String con el ID de las funciones, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta Estándar
400	Bad Request	Uno de 'Bad Request', 'Can Not Update User Without Role', 'Can Only Update Yourself', 'Can Not Update Yourself', 'Can Not Update an User With Role Above' o 'Can Not Update an User To Role Above'

Esta operación no requiere autenticación

Eliminar Usuario

DELETE /v2/users/{id}

Datos de Envío

{
  "params": {
    "id": "abc123def456ghi"
  }
}

Campo	Descripción	Obrigatório
id	String que representa un identificador. Debe consistir en 15 caracteres alfanuméricos (letras mayúsculas y minúsculas y dígitos).	sí

Respuestas

Status	Significado	Descripción
200	OK	Respuesta Estándar
400	Bad Request	Uno de los siguientes: 'Solicitud Incorrecta', 'No es Posible Eliminarse a Sí Mismo' o 'No es Posible Eliminar un Usuario Con Rol Superior'
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Actualizar Usuarios {situation}

PATCH /v2/users/{id}/status/{situation}

Parámetros

{
  "params": {
    "id": "ABC1234567890DEF",
    "situation": "activation"
  }
}

Campo	Descripción	Obligatorio
id	String que contiene el ID, debe seguir el patrón alfanumérico y tener una longitud de 15 caracteres.	sí
situation	String que indica la situación, debe ser 'activation' o 'deactivation'.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar

Esta operación no requiere autenticación

Dispositivos Empresas