Listar departamentos

Este endpoint permite listar departamentos com filtros e paginação.


Campos obrigatórios

Nenhum.

Campos opcionais (query)

  • name: Filtro por nome.
  • externalCode: Filtro por código externo.
  • page: Número da página (padrão 1).
  • maxPageSize: Tamanho da página (máximo 100).

Exemplo de requisição (cURL)

curl --request GET \
     --url 'https://api.gupy.io/os/v1/departments?name=Produto&page=1&maxPageSize=10' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here'

Atenção: Forneça o token no cabeçalho Authorization.

Possíveis erros

Não autenticado (401)

Token ausente ou inválido.


Buscar departamento por UUID

Este endpoint retorna um departamento pelo uuid.

Parâmetros de path

  • uuid: UUID do departamento (obrigatório).

Exemplo de requisição (cURL)

curl --request GET \
     --url 'https://api.gupy.io/os/v1/departments/uuid/d20dc017-80c6-4706-bbfe-549c1cc4d2c1' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer bearer_token_value_here'

Atenção: Substitua o UUID pelo valor real.

Possíveis erros

Departamento não encontrado (404)

{
  "message": "Department with UUID d20dc017-80c6-4706-bbfe-549c1cc4d2c1 not found"
}