Paginação e filtros
page e perPage. A primeira página é 1 e perPage aceita no máximo 100 itens.Formato da página
meta.page, meta.perPage, meta.totalPages e meta.totalCount. A listagem de conteúdo de pasta retorna meta.page, meta.perPage e meta.hasMore.Envelopes
GET /v4/api/envelopes/ aceita page, perPage, orderBy (title, createdAt ou updatedAt), order (asc ou desc), status, q, startDate, endDate, folderId, updatedSince (ISO 8601; envelopes atualizados a partir dessa data), participantName, participantEmail, participantPhone, participantStatus e tagIds.participantStatus filtra pelo estado da ação de algum participante do envelope. Quando vem junto de participantName, participantEmail ou participantPhone, todos os critérios valem para o mesmo participante.| Valor | Devolve envelopes com algum participante que… |
|---|---|
PENDING | tem ação a fazer agora e ainda não cumpriu: signatário ou aprovador que não assinou/aprovou (mesmo que já tenha aberto o link), ou observador com visualização obrigatória que ainda não visualizou. Só envelopes em andamento (status SENT). |
COMPLETED | já cumpriu a sua parte: signatário assinou, aprovador aprovou, ou observador visualizou. |
DECLINED | recusou. |
PENDING: quem ainda aguarda a própria vez num fluxo sequencial (etapa futura), o observador sem visualização obrigatória e o observador que já visualizou. Combinado com outro status de envelope, PENDING devolve lista vazia, porque só existe ação pendente em envelope enviado.tagIds filtra por etiqueta: ids separados por vírgula (até 50), vindos de GET /v4/api/tags. Devolve os envelopes com qualquer uma das etiquetas, sempre dentro do que a chave já listaria. Cada envelope da resposta traz tags, a lista das suas etiquetas (id, name, color), em ordem de nome.Contatos
GET /v4/api/contacts/ aceita page, perPage e q.Conteúdo de pasta
GET /v4/api/folders/contents aceita parentId, page, perPage, q, orderBy (name ou createdAt), order (asc ou desc) e foldersOnly (true ou false). Sem parentId, a consulta parte da raiz.Modificado em 2026-09-29 14:16:55