Listagem de Contratos
Podemos listar todos os contratos cadastrados em nosso sistema ou listar apenas um contrato específico.
GET /contracts
GET /contractsEsse endpoint permite que você consulte todos os contratos.
Clique aqui para testar endpoint
Todos os endpoints deverão ser autenticados
headers = {
'Authorization': f'Bearer {api_key}'
}Exemplo de resposta:
{
"data": [
{
"deny_reason": null,
"status": {
"color": 3,
"id": 1640,
"name": "Ag.Assinatura"
},
"begin_date": null,
"number": "2024/14",
"workflow": null,
"current_document": {
"contract": {
"id": 175989
},
"draft": null,
"editor": "tinymce",
"file": {
"download_url": "url de download do arquivo",
"google_file_id": null,
"id": 199761,
"inserted_at": "2024-05-03T18:50:18",
"mime": "application/pdf",
"name": "CK Summit.pdf",
"preview_url": "url de visualização prévia do arquivo",
"size": 22065665,
"updated_at": "2024-05-03T18:50:18"
},
"id": "33c41c0e-d697-4fee-a8c0-795aacb7c360",
"inserted_at": "2024-05-03T18:50:41",
"notes": null,
"organization": {
"id": 1199
},
"proofs": [
{
"deleted_at": null,
"document": {
"id": "33c41c0e-d697-4fee-a8c0-795aacb7c360"
},
"events": [
{
"action": "create",
"changed_field": null,
"from": null,
"id": 220220,
"inserted_at": "2024-05-03T18:50:57",
"item_type": "ProofEvent",
"proof": {
"id": 14559
},
"subject": null,
"to": null,
"user": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
}
}
],
"id": 14559,
"inserted_at": "2024-05-03T18:50:57",
"ordered": false,
"organization": {
"id": 1199
},
"original_file": {
"download_url": "[URL truncated for brevity]",
"google_file_id": null,
"id": 199761,
"inserted_at": "2024-05-03T18:50:18",
"mime": "application/pdf",
"name": "CK Summit.pdf",
"preview_url": "[URL truncated for brevity]",
"size": 22065665,
"updated_at": "2024-05-03T18:50:18"
},
"packaged_file": null,
"preview_file": null,
"proof_subject_requested_changes": [],
"receipt_file": null,
"requester": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
},
"signed_file": null,
"signing_file": {
"download_url": "[URL truncated for brevity]",
"google_file_id": null,
"id": 199762,
"inserted_at": "2024-05-03T18:50:56",
"mime": "application/pdf",
"name": "CK Summit.pdf",
"preview_url": "[URL truncated for brevity]",
"size": 22073258,
"updated_at": "2024-05-03T18:50:56"
},
"status": "pending",
"subjects": [
{
"approve_subject_change": null,
"certificate_company_document": null,
"certificate_company_name": null,
"certificate_document": null,
"certificate_email": null,
"certificate_name": null,
"company": null,
"company_document": null,
"company_name": null,
"confirmed_at": null,
"confirmed_ip_address": null,
"confirmed_user_agent": null,
"delivered_at": null,
"document": null,
"email": "[email protected]",
"engine": "standard",
"id": 19449,
"inserted_at": "2024-05-03T18:50:57",
"name": "Davi",
"notification_type": "email",
"order": 1,
"party": {
"trade_name": null,
"address_zip_code": null,
"form": null,
"document": null,
"reference": null,
"address_street": null,
"id": 341261,
"address_state": null,
"name": "Davi",
"national_id": null,
"inserted_at": "2024-01-25T17:28:02",
"birth_date": null,
"contact_name": null,
"reps": null,
"organization": {
"id": 1199
},
"updated_at": "2024-05-06T19:39:41",
"email": "[email protected]",
"address_complement": null,
"phone": null,
"contact_email": null,
"address_number": null,
"marital_status": "divorced",
"address_neighborhood": null,
"state_subscription": null,
"person_type": "pf",
"contact_phone": null,
"imported_id": null,
"address_country": "BR",
"nationality": null,
"address_city": null,
"city_subscription": null,
"whatsappnum": null,
"profession": null
},
"proof": {
"id": 14559
},
"qualification": "Contratada",
"refused_changes_at": null,
"sent_at": "2024-05-03T18:50:57.632000Z",
"updated_at": "2024-05-03T18:50:57",
"viewed_at": null,
"whatsappnum": null
}
],
"updated_at": "2024-05-03T18:50:57"
}
],
"updated_at": "2024-05-03T18:50:41",
"user": {
"id": 3056
}
},
"classifier": null,
"tasks": [
{
"content": "descrição da tarefa",
"contract": {
"id": 175989
},
"done": false,
"due_date": "2021-04-30",
"id": 1123,
"inserted_at": "2024-05-10T17:56:57",
"priority": 2,
"progress": {},
"recurrence_count": 1,
"recurrence_frequency": "weekly",
"recurring": true,
"requester": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
},
"title": "Seguro de Equipamentos",
"updated_at": "2024-05-10T17:56:57",
"user_ids": [
3056
],
"users": [
{
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
}
]
}
],
"archived": false,
"due_notice": 60,
"id": 175989,
"shares": "[Array truncated for brevity]",
"inserted_at": "2024-05-03T18:50:41",
"observations": null,
"attachments": [],
"financial": [],
"form_submission": null,
"organization": {
"active": true,
"addons": [],
"available_proof_engines": [
"standard"
],
"domains": [],
"id": 1199,
"inserted_at": "2023-12-15T19:35:45",
"logo_url": null,
"name": "CK API Development Corp",
"organization_plan": {
"document_history": false,
"form_review_flow": false,
"id": 1193,
"inserted_at": "2023-12-15T19:35:45",
"organization": {
"id": 1199
},
"plan": {
"id": 7
},
"price": "199.90",
"price_user": "56.33",
"redlining": false,
"sharelink": false,
"signature_counter": 1,
"updated_at": "2023-12-15T19:35:45",
"whatsapp_link": false,
"whatsapp_monthly_quota": 0,
"whatsapp_notification": false
},
"organizations_users": null,
"statuses": null,
"updated_at": "2024-05-15T15:07:36",
"workflows": null
},
"object": null,
"comments": [],
"updated_at": "2024-05-03T18:50:57",
"review_flows_events": [],
"pendencies": 1,
"assignee": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
},
"title": "CK Summit",
"term_type": null,
"deleted": false,
"needs_acceptance": false,
"end_date": null,
"childrem_contracts": [],
"prev_status": null,
"custom_fields": [],
"parent_contract": null,
"review_flow": null,
"prev_assignee": null
}
],
"filtered_results": 2,
"page_number": 1,
"page_size": 16,
"total_pages": 1
}O retorno desse endpoint será um array de objetos contendo todos os contratos listados.
GET /contracts/{contract_id}
GET /contracts/{contract_id}Esse endpoint permite que você consulte um contrato específico através de seu id.
Clique aqui para testar endpoint
Lembre-se de substituir a variável {contract_id} no parâmetro da rota pelo valor id do contrato que você deseja listar.
Exemplo de resposta:
{
"data": {
"deny_reason": null,
"status": {
"color": 1,
"id": 1638,
"name": "Rascunho"
},
"begin_date": null,
"number": "2024/21",
"workflow": {
"contracts_count": null,
"id": 2379,
"inserted_at": "2024-05-15T15:07:23",
"is_default": false,
"name": "Título para o workflow",
"organization": {
"id": 1199
},
"statuses": null,
"updated_at": "2024-05-15T15:07:23",
"users": null
},
"current_document": {
"contract": {
"id": 176020
},
"draft": null,
"editor": "tinymce",
"file": {
"download_url": "[URL truncated for brevity]",
"google_file_id": null,
"id": 199849,
"inserted_at": "2024-05-15T15:06:49",
"mime": "application/pdf",
"name": "dummy.pdf",
"preview_url": "[URL truncated for brevity]",
"size": 13264,
"updated_at": "2024-05-15T15:06:49"
},
"id": "caf82d77-c883-4c97-8f8d-905e894a4ec0",
"inserted_at": "2024-05-15T15:07:37",
"notes": null,
"organization": {
"id": 1199
},
"proofs": [],
"updated_at": "2024-05-15T15:07:37",
"user": {
"id": 3056
}
},
"classifier": null,
"tasks": [],
"archived": false,
"due_notice": 60,
"id": 176020,
"shares": [],
"inserted_at": "2024-05-15T15:07:37",
"observations": null,
"attachments": [],
"financial": [],
"form_submission": null,
"organization": {
"active": true,
"addons": [],
"available_proof_engines": [
"standard"
],
"domains": [],
"id": 1199,
"inserted_at": "2023-12-15T19:35:45",
"logo_url": null,
"name": "CK API Development Corp",
"organization_plan": {
"document_history": false,
"form_review_flow": false,
"id": 1193,
"inserted_at": "2023-12-15T19:35:45",
"organization": {
"id": 1199
},
"plan": {
"id": 7
},
"price": "199.90",
"price_user": "56.33",
"redlining": false,
"sharelink": false,
"signature_counter": 1,
"updated_at": "2023-12-15T19:35:45",
"whatsapp_link": false,
"whatsapp_monthly_quota": 0,
"whatsapp_notification": false
},
"organizations_users": null,
"statuses": null,
"updated_at": "2024-05-15T15:07:36",
"workflows": null
},
"object": null,
"comments": [],
"updated_at": "2024-05-15T15:33:12",
"review_flows_events": [],
"pendencies": 0,
"assignee": {
"activated": true,
"activity": "Desenvolvedor Jr",
"cpf": "136.382.516-08",
"email": "[email protected]",
"first_name": "Davi",
"gender": "unspecified",
"id": 3056,
"last_name": "Ferreira",
"marital_status": null,
"organizations_users": null
},
"title": "Titulo do Contrato Teste",
"term_type": null,
"deleted": true,
"needs_acceptance": false,
"end_date": null,
"childrem_contracts": [],
"prev_status": null,
"custom_fields": [],
"parent_contract": null,
"review_flow": null,
"prev_assignee": null
}
}Updated 16 days ago