Listagem de Participantes
Podemos listar todos os participantes cadastrados em nosso sistema ou listar apenas um participante específico.
GET /parties
GET /partiesEsse endpoint permite que você consulte todas as pessoas e empresas.
Clique aqui para testar endpoint
Todos os endpoints deverão ser autenticados
headers = {
'Authorization': f'Bearer {api_key}'
}Exemplo de resposta:
{
"data": [
{
"trade_name": "Nome fantasia da empresa aqui",
"address_zip_code": "36400-000",
"form": null,
"document": "22.516.356/0001-15",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346154,
"address_state": "MG",
"name": "Razão social da empresa aqui",
"national_id": null,
"inserted_at": "2024-05-14T15:27:34",
"birth_date": "1997-08-28",
"contact_name": "Nome da pessoa responsável",
"reps": 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": null,
"organizations_users": null,
"statuses": null,
"updated_at": "2024-05-09T19:04:58",
"workflows": null
},
"updated_at": "2024-05-14T15:27:34",
"email": null,
"address_complement": "Complemento do endereço",
"phone": "(99) 99999-9999",
"contact_email": "seuemail@email.com",
"address_number": "25",
"marital_status": null,
"address_neighborhood": "Centro",
"state_subscription": "843.774.723/9603",
"person_type": "pj",
"contact_phone": "(99) 99999-9999",
"imported_id": null,
"address_country": "Brasil",
"nationality": null,
"address_city": "Belo Horizonte",
"city_subscription": "843.774.723/9603",
"whatsappnum": "+55 31 99999-9999",
"profession": null
},
{
"trade_name": null,
"address_zip_code": "36401-000",
"form": null,
"document": "547.407.480-88",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346153,
"address_state": "MG",
"name": "Seu nome aqui",
"national_id": "00000000",
"inserted_at": "2024-05-14T15:11:52",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": 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": null,
"organizations_users": null,
"statuses": null,
"updated_at": "2024-05-09T19:04:58",
"workflows": null
},
"updated_at": "2024-05-14T15:11:52",
"email": "seuemail@email.com",
"address_complement": "Complemento do endereço",
"phone": "(31) 98700-1467",
"contact_email": null,
"address_number": "25",
"marital_status": "single",
"address_neighborhood": "Centro",
"state_subscription": null,
"person_type": "pf",
"contact_phone": null,
"imported_id": null,
"address_country": "Brasil",
"nationality": "Brasileiro",
"address_city": "Belo Horizonte",
"city_subscription": null,
"whatsappnum": "+55 31 98700 1467",
"profession": "Dev"
}
]
}
O retorno desse endpoint será um array de objetos contendo todos os participantes listados.
GET /parties/{party_id}
GET /parties/{party_id}Esse endpoint permite que você consulte uma pessoa ou empresa específica através de seu id.
Lembre-se de substituir a variável {party_id} no parâmetro da rota pelo valor id do participante que você deseja listar.
Exemplo de resposta:
{
"data": {
"trade_name": null,
"address_zip_code": "36401-000",
"form": null,
"document": "547.407.480-88",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346153,
"address_state": "MG",
"name": "Seu nome aqui",
"national_id": "00000000",
"inserted_at": "2024-05-14T15:11:52",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": 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": null,
"organizations_users": null,
"statuses": null,
"updated_at": "2024-05-09T19:04:58",
"workflows": null
},
"updated_at": "2024-05-14T15:11:52",
"email": "seuemail@email.com",
"address_complement": "Complemento do endereço",
"phone": "(31) 98700-1467",
"contact_email": null,
"address_number": "25",
"marital_status": "single",
"address_neighborhood": "Centro",
"state_subscription": null,
"person_type": "pf",
"contact_phone": null,
"imported_id": null,
"address_country": "Brasil",
"nationality": "Brasileiro",
"address_city": "Belo Horizonte",
"city_subscription": null,
"whatsappnum": "+55 31 98700 1467",
"profession": "Dev"
}
}GET /parties?search={nome ou email}
GET /parties?search={nome ou email}Esse endpoint permite que você consulte uma pessoa ou empresa específica por query params.
Nessa rota, search deverá receber o valor do nome ou email da pessoa ou empresa que deseja listar.
Exemplo de resposta:
{
"data": [
{
"trade_name": null,
"address_zip_code": "36401-000",
"form": null,
"document": "547.407.480-88",
"reference": "Praça da liberdade",
"address_street": "Av Car",
"id": 346155,
"address_state": "MG",
"name": "Query Params",
"national_id": "00000000",
"inserted_at": "2024-05-14T16:11:45",
"birth_date": "1997-08-28",
"contact_name": null,
"reps": 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": null,
"organizations_users": null,
"statuses": null,
"updated_at": "2024-05-09T19:04:58",
"workflows": null
},
"updated_at": "2024-05-14T16:11:45",
"email": "seuemail@email.com",
"address_complement": "Complemento do endereço",
"phone": "(31) 98700-1467",
"contact_email": null,
"address_number": "25",
"marital_status": "single",
"address_neighborhood": "Centro",
"state_subscription": null,
"person_type": "pf",
"contact_phone": null,
"imported_id": null,
"address_country": "Brasil",
"nationality": "Brasileiro",
"address_city": "Belo Horizonte",
"city_subscription": null,
"whatsappnum": "+55 31 98700 1467",
"profession": "Dev"
}
],
"page_number": 1,
"page_size": 16,
"total_pages": 1
}Updated 3 months ago
Did this page help you?