Skip to main content
GET
Listar projetos

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

X-Sub-Account
string

Reference da subconta em que a operação deve ser executada. Quando omitido, a operação acontece na conta principal; o valor reservado principal também resolve para a conta principal e é equivalente a omitir o header. Aceito em todos os endpoints, exceto POST /auth e os próprios endpoints de /sub-accounts, que sempre operam na conta principal.

Erros possíveis: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Exige que a credencial tenha o acesso a subcontas habilitado (Configurações → Integração → Credenciais de API). Ele nasce desligado e não é substituído por nenhuma permissão, nem por FULL_ACCESS: sem ele a resposta é 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Exemplo:

"loja-centro"

Parâmetros de consulta

page
integer
padrão:1

Número da página

Intervalo obrigatório: x >= 1
limit
integer
padrão:20

Itens por página

Intervalo obrigatório: 1 <= x <= 100
sortBy
enum<string>
padrão:createdAt

Ordenar por campo

Opções disponíveis:
createdAt,
updatedAt,
name
sortOrder
enum<string>
padrão:desc

Ordem de classificação

Opções disponíveis:
asc,
desc

Resposta

Lista de projetos

items
object[]
obrigatório

Lista de projetos

total
integer
obrigatório

Número total de projetos

Exemplo:

100

page
integer
obrigatório

Página atual

Exemplo:

1

limit
integer
obrigatório

Itens por página

Exemplo:

20

totalPages
integer
obrigatório

Número total de páginas

Exemplo:

5