Todos os produtos
Search
Central de documentação

Qoder CN Series:ListDepartments

Última atualização: Jun 29, 2026

Use esta API para consultar a lista de departamentos da organização.

Edições compatíveis

Enterprise Dedicated Edition

Endpoints de serviço

Obtenha o endpoint de serviço e substitua {domain} na sintaxe de requisição da API pelo seu endpoint.

Informações de autorização

Produto

Recurso

Permissão necessária

Organization Management

Departamentos da organização

Somente leitura

Sintaxe da requisição

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/departments

Descrição da requisição

Consultar a lista de departamentos da organização

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/organizations/9a2b****5ef1/departments' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Consultar todos os subdepartamentos de um departamento específico

curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/organizations/9a2b****5ef1/departments?parentId=99d1****71d4&page=1&perPage=100' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Cabeçalhos da requisição (Headers)

x-yunxiao-token string (Obrigatório)

O token de acesso. Consulte Token de acesso para obter detalhes.

Exemplo: pt-0fh3****0fbG_35af****0484.

Parâmetros da requisição

organizationId string (Obrigatório)

ID da organização. Acesse a página System Management no console do Organization Management para obter o ID da organização (organizationId).

parentId string (Opcional)

ID do departamento pai.

page integer (Opcional) Valor padrão: 1

Página atual.

perPage integer (Opcional) Valor padrão: 100

Número de entradas por página. Valores válidos: [1, 100].

Parâmetros de resposta

Exemplo de resposta

[
    {
        "creatorId": "99d1****6124",
        "hasSub": true,
        "id": "99d1****6124",
        "name": "Example",
        "organizationId": "99d1****6124",
        "parentId": "99d1****6124"
    }
]

creatorId string

ID do criador.

hasSub boolean

Indica se o departamento tem subdepartamentos.

id string

ID do departamento.

name string

Nome do departamento.

organizationId string

ID da organização.

parentId string

ID do departamento pai.

Cabeçalho de resposta

Parâmetro

Descrição

Valor de exemplo

x-next-page

Próxima página.

1

x-page

Página atual.

2

x-per-page

Número de entradas por página.

1

x-prev-page

Página anterior.

2

x-total

Número total de entradas.

1

x-total-pages

Número total de páginas.

10

Códigos de erro

Para mais informações, consulte a Central de códigos de erro.