Painel da empresa › Contratos
Listar contratos
GET/api/v1/contractsPede sessãoComo funciona
Os contratos enviados para assinatura, paginados: médico, CRM, e-mail, especialidade, modelo, escala, situação, quando foi enviado, quando foi assinado, quando foi cancelado (ou recusado, ou venceu), o tipo (contract ou termination) e quantas vezes o link foi reenviado.
Pede a permissão de ver contratos.
Parâmetros
pageQuery · integerPágina, a partir de 1. Padrão: 1.pageSizeQuery · integerItens por página. Padrão: 50; máximo: 100.
Respostas
200 · contracts da página e pagination com o total.
contractsobject[] · Contratos.contracts[].cancelledAtstring · Quando foi cancelado, recusado ou venceu.contracts[].crmstring · Número do CRM.contracts[].doctorNamestring · Nome do médico.contracts[].emailstring · E-mail.contracts[].idstring · Identificador do registro.contracts[].kindstring · Tipo:contractoutermination(termo de distrato).contracts[].resendCountinteger · Quantas vezes o link foi reenviado.contracts[].scalestring · Escala do médico neste contrato.contracts[].sentAtstring · Quando foi enviado.contracts[].signedAtstring · Quando foi assinado.contracts[].specialtystring · Especialidade.contracts[].statusstring · Situação.contracts[].templateNamestring · Nome do modelo.paginationobject · Paginação: página, tamanho e total.pagination.pageinteger · Página.pagination.pageSizeinteger · Itens por página.pagination.totalinteger · Total.
Corpo de exemplo
{
"contracts": [
{
"cancelledAt": "texto",
"crm": "texto",
"doctorName": "texto",
"email": "medico@exemplo.com.br",
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"kind": "texto",
"resendCount": 1,
"scale": "texto",
"sentAt": "texto",
"signedAt": "texto",
"specialty": "texto",
"status": "texto",
"templateName": "texto"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"total": 1
}
}