UsuáriosConsultar Usuário por ID

Consultar Usuário por ID

Retorna os dados de um usuário específico da empresa pelo userId. Use este endpoint quando você já conhece o identificador do usuário e quer consultar ou atualizar o contexto de um único usuário sem paginar a listagem completa.

Regras:

  • O userId é o campo id retornado por GET /users/v1/users.
  • Retorna 404 se o usuário não pertencer à empresa autenticada.
curl -X GET "https://api-sandbox.contasimples.com/users/v1/users/550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "joao.silva@empresa.com.br",
  "name": "João Silva",
  "phone": "11999999999",
  "role": {
    "id": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c",
    "name": "Contador(a)"
  },
  "active": true
}
GET
/users/v1/users/{userId}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
path
userIdstring
Required

ID do usuário (UUID v4) — use o valor do campo id retornado em GET /users/v1/users (ex.: 550e8400-e29b-41d4-a716-446655440000).

Format: uuid
header
Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header
Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

userIdstring
Required

ID do usuário (UUID v4) — use o valor do campo id retornado em GET /users/v1/users (ex.: 550e8400-e29b-41d4-a716-446655440000).

Example:
550e8400-e29b-41d4-a716-446655440000

Headers

Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Responses

idstring
Required

Identificador único do usuário.

emailstring
Required

E-mail do usuário.

namestring
Required

Nome do usuário.

phonestring

Telefone do usuário.

roleobject
Required

Perfil de acesso atribuído ao usuário na empresa.

activeboolean
Required

Indica se o usuário está ativo na empresa.