Listar projetos

Lista os projetos da conta, com paginação e filtros. Use esta operação para montar telas de listagem ou sincronizar projetos. O filtro situation[] é obrigatório: sem ele, a API retorna HTTP 400. Atenção ao meta.count da resposta — como records é um objeto {total, projects} (não um array de projetos), o count reflete a quantidade de chaves de records (sempre 2), e não a quantidade de projetos retornados; use records.total para saber o total de registros que atendem ao filtro.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
situation[]
array of strings
required

Filtra pela situação do projeto. Repita o parâmetro para combinar valores (ex.: situation[]=active&situation[]=archived).

situation[]*
Allowed:
integer
≥ 1
Defaults to 20

Quantidade de registros por página. Padrão de 20 em Projetos.

integer
Defaults to 0

Deslocamento; pula a quantidade de registros informada antes de começar a retornar resultados.

string

Filtra pelo título do projeto (busca textual).

statusIds[]
array of integers

Filtra pelo id do status do projeto.

statusIds[]
integer
enum

Filtra projetos privados (1) ou não privados (0).

Allowed:
string

Filtra pela data de criação do projeto (createdAt). É um JSON {"range":[dataInicial,dataFinal],"period":"custom"}, codificado como string na query string. O único period aceito é custom.

string

Ordenação dos registros. É um JSON {"column","direction"}, codificado como string na query string. column aceita projectNumber, docTitle, client ou createdAt; direction aceita ASC ou DESC.

Responses

401

Op-Auth-Token expirado ou inválido. Resposta sem corpo.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json