Usuários

Listar Usuários

GET /v2/users

Parâmetro	Descrição
attributes	Especifica quais atributos recuperar. Pode incluir valores como 'serial', 'number', 'carrier', 'service_provider' e 'batch'. Se nulo, recupera todas as informações.
includes	Especifica entidades relacionadas para incluir na consulta. Contém arrays para 'dispositivo' e 'empresa' com valores como 'name', 'imei', 'code', 'cnpj'.
filters	Especifica filtros para vários campos como 'chips.serial', 'chips.number', 'device.name', etc. Cada campo de filtro suporta condições como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica a consulta de pesquisa com um comprimento máximo de 100 caracteres.
limit	Especifica o número máximo de resultados a serem retornados. Deve ser um número entre 1 e 100.
page	Especifica o número da página para resultados paginados. Deve ser um número maior ou igual a 0.
count	Indica se incluir a contagem total de resultados na resposta.
sort	Especifica critérios de ordenação para os campos 'number' e 'serial'. Os valores podem ser -1 (ordem decrescente) ou 1 (ordem crescente).

Respostas

Status	Significado	Descrição
200	OK	Resposta Padrão
400	Bad Request	Solicitação Inválida

Esta operação não requer autenticação

Criar Usuário

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	Descrição	Obrigatório
data	Objeto	sim
attributes	Objeto contendo atributos de dados do usuário.	sim
- username	String com o nome de usuário do usuário, com espaços removidos, com um comprimento entre 1 e 255 caracteres.	sim
- email	String com o endereço de e-mail do usuário, validado como um formato de e-mail.	sim
- name	String com o nome do usuário, com um comprimento máximo de 255 caracteres.	sim
- phone1	String com o número de telefone principal do usuário, com um comprimento máximo de 20 caracteres.	não
- phone2	String com o número de telefone secundário do usuário, com um comprimento máximo de 20 caracteres.	não
- emergency_contact	String com as informações de contato de emergência do usuário, com um comprimento máximo de 255 caracteres.	não
- emergency_phone	String com o número de telefone de emergência do usuário, com um comprimento máximo de 20 caracteres.	não
- document_number	String com o número do documento do usuário, com um comprimento máximo de 20 caracteres.	não
- cpf	String com o CPF do usuário, com espaços removidos, com um comprimento entre 1 e 20 caracteres.	sim
- birthdate	Data de nascimento do usuário.	não
- locale	String com a localidade do usuário, deve ser uma das opções 'pt_BR', 'es_UY' ou 'en_US'.	sim
relationships	Objeto contendo dados de relacionamento.	sim
- enterprise	Objeto representando o relacionamento com uma empresa.	sim
-- type	String com o tipo de relacionamento, deve ser 'enterprise'.	sim
-- id	String com o ID da empresa, deve consistir em 15 caracteres alfanuméricos.	sim
- roles	Objeto representando o relacionamento com funções.	não
-- type	String com o tipo de relacionamento, deve ser 'roles'.	sim
-- id	String com o ID das funções, deve consistir em 15 caracteres alfanuméricos.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta Padrão
400	Bad Request	Solicitação Inválida
401	Unauthorized	Não Autorizado
404	Not Found	Não Encontrado

Esta operação não requer autenticação

Mostrar Usuário

GET /v2/users/{id}

Campo	Descrição
attributes	Array de atributos a serem recuperados. Pode conter valores como 'username', 'email', 'name', etc. Se nulo, todas as informações são recuperadas.
includes	Especifica entidades relacionadas a incluir na consulta. Contém arrays para 'addresses', 'document' e 'enterprise', que podem incluir valores como 'formatted_address', 'city', 'name', etc.
- addresses	Array de atributos de endereço a serem incluídos. Pode conter valores como 'formatted_address', 'city', 'region', 'zip_code'.
- document	Array de atributos de documento a serem incluídos. Pode conter valores como 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'.
- enterprise	Array de atributos de empresa a serem incluídos. Pode conter valores como 'name', 'cnpj'.

Responses

Status	Significado	Descrição
200	OK	Resposta Padrão
400	Bad Request	Solicitação Inválida
401	Unauthorized	Não Autorizado
404	Not Found	Não Encontrado

This operation does not require authentication

Atualizar Usuário

PATCH /v2/users/{id}

Dados de Envio útil

{
  "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"
        },
        "funções": {
          "type": "funções",
          "id": "role123"
        }
      }
    }
  }
}

Campo	Descrição	Obrigatório
data	Objeto	sim
atributos	Objeto contendo atributos de dados do usuário.	sim
- username	String com o nome de usuário do usuário, cortado, com um comprimento entre 1 e 255 caracteres.	sim
- email	String com o endereço de e-mail do usuário, validado como formato de e-mail.	sim
- name	String com o nome do usuário, com um comprimento máximo de 255 caracteres.	sim
- phone1	String com o número de telefone principal do usuário, com um comprimento máximo de 20 caracteres.	não
- phone2	String com o número de telefone secundário do usuário, com um comprimento máximo de 20 caracteres.	não
- emergency_contact	String com as informações de contato de emergência do usuário, com um comprimento máximo de 255 caracteres.	não
- emergency_phone	String com o número de telefone de emergência do usuário, com um comprimento máximo de 20 caracteres.	não
- document	String com o número do documento do usuário, com um comprimento máximo de 20 caracteres.	não
- cpf	String com o CPF do usuário, cortado, com um comprimento entre 1 e 20 caracteres.	sim
- birthdate	Data de nascimento do usuário.	não
- locale	String com a localidade do usuário, deve ser um dos seguintes: 'pt_BR', 'es_UY' ou 'en_US'.	sim
relationships	Objeto contendo dados de relacionamento.	sim
- enterprise	Objeto representando o relacionamento com uma empresa.	sim
-- type	String com o tipo de relacionamento, deve ser 'enterprise'.	sim
-- id	String com o ID da empresa, deve consistir em 15 caracteres alfanuméricos.	sim
- roles	Objeto representando o relacionamento com funções.	não
-- type	String com o tipo de relacionamento, deve ser 'roles'.	sim
-- id	String com o ID das funções, deve consistir em 15 caracteres alfanuméricos.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um 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' ou 'Can Not Update an User To Role Above'
401	Unauthorized	Não autorizado
404	Not Found	Não encontrado

Esta operação não requer autenticação

Excluir Usuário

DELETE /v2/users/{id}

Dados de Envio

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

Campo	Descrição	Obrigatório
id	String representando um identificador. Deve consistir em 15 caracteres alfanuméricos (letras maiúsculas e minúsculas e dígitos).	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta Padrão
400	Bad Request	Um de 'Bad Request', 'Can Not Delete Self' ou 'Can Not Delete an User With Role Above'
401	Unauthorized	Não autorizado
404	Not Found	Não encontrado

Esta operação não requer autenticação

Atualizar Usuários {situation}

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

Parâmetros

{
  "params": {
    "id": "ABC1234567890DEF",
    "situação": "activation"
  }
}

Campo	Descrição	Obrigatório
id	String contendo o ID, deve seguir o padrão alfanumérico e ter um comprimento de 15 caracteres.	sim
situation	String indicando a situação, deve ser 'activation' ou 'deactivation'.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta Padrão

Esta operação não requer autenticação

Dispositivos Empresas