Referência API
Postman CollectionStatus PageReferência APIGrafeno Digital

Consulta de Documentos

get
https://signer.dev.grafeno.be/api/documents

Consulta os documentos da organização com suporte a paginação. Vários filtros podem ser aplicados para refinar os resultados.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filtra pelo status do documento. Substitui a propriedade IsConcluded. Valores disponíveis: PendingOrRefused, Concluded, CanceledOrExpired, Pending, Refused, Canceled, Expired.

string

Filtra pelo ID da pasta.

string

Filtra pelo tipo de pasta. Valores disponíveis: Normal, WithoutFolder.

string

Filtra pelo tipo de documento. Valores disponíveis: Deed, PowerOfAttorney, Prescription, MedicalCertificate, ExamRequest, LabReport, DischargeSummary, ClinicalRecord, DrugDispensing, Vaccination, MedicalReport.

boolean

Defina como true para filtrar documentos por tipo. Use DocumentType para especificar o tipo de documento.

boolean

Defina como true para filtrar apenas os documentos que têm ações de fluxo do tipo Signer ou SignRule.

string

Valores disponíveis: Name, Key, Id, CreatorName, Tag.

string

Consulta para filtrar por participante.

string

Valores disponíveis: Name, Identifier, Email, Phone.

string

Pares de rótulo/valor separados por `

boolean

Retorna documentos excluídos que tinham o status de documento especificado quando excluídos.

string

Consulta para filtrar itens.

int32

Número de itens a serem retornados.

int32

O deslocamento da página pesquisada (começando com 0).

string

Ordem dos resultados. Valores disponíveis: Asc, Desc.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

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

Updated 11 months ago