SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Primeiro envelope em 5 minutos
      • Integrar com IA
      • Testar a API no Postman
      • Paginação e filtros
      • Catálogo de erros
      • Receitas em Node.js, PHP e Python
      • Changelog
      • Idempotência e erros
      • Estados do envelope
      • Webhooks
      • Limites de requisição
    • Referência da API
      • Conta
        • Consultar a conta da integração
        • Consultar capacidades da integração
        • Consultar o catálogo de capacidades
        • Validar a chave de API
      • Envelopes
        • Excluir rascunho de envelope
        • Consultar histórico do envelope
        • Criar rascunho de envelope
        • Listar envelopes
        • Atualizar configurações do envelope
        • Enviar envelope
        • Get Envelope
        • Move envelope to folder
        • Void envelope
      • Participantes
        • Listar participantes do envelope
        • Sincronizar participantes
        • Enviar lembrete ao participante
      • Documentos
        • Listar documentos do envelope
        • Substituir campos do documento
        • Listar campos do documento
        • Adicionar documento ao envelope
        • Gerar URL de download do documento
      • Contatos
        • Criar contato
        • Listar contatos
        • Consultar contato
        • Atualizar contato
        • Excluir contato
      • Equipe
        • Listar membros da conta
      • Pastas
        • Listar conteúdo da pasta
        • Consultar acesso da pasta
        • Excluir pasta
        • Renomear pasta
        • Mover pasta
        • Criar pasta
      • Convites
        • Listar convites da conta
      • Webhooks
        • Excluir webhook
        • Criar webhook
        • List webhook endpoints
        • Edit webhook endpoint
  1. Introdução

Paginação e filtros

As coleções paginadas usam page e perPage. A primeira página é 1 e perPage aceita no máximo 100 itens.

Formato da página#

Listagens de envelopes e contatos retornam 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 ou createdAt), order (asc ou desc), status, q, startDate, endDate, participantName, participantEmail e participantPhone.

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.
Codifique os valores da query string e não monte filtros com dados não escapados.
Modificado em 2026-09-08 22:04:56
Página anterior
Testar a API no Postman
Próxima página
Catálogo de erros
Built with