Guides

Listagem de Participantes do Contrato

Suggest Edits

Podemos listar todos os participantes de um contrato ou um participante específico daquele contrato.

GET /contracts/{contract_id}/shares

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}'
}

⚠️ Lembre-se de substituir a variável {contract_id} no parâmetro da rota pelo valor id do contrato que você deseja listar os participantes anteriormente associados.

Exemplo de resposta:

{
    "data": [
        {
            "company": null,
            "contract": {
                "id": 176022
            },
            "email_viewed_at": null,
            "engine": "standard",
            "id": 345642,
            "inserted_at": "2024-05-15T20:12:31",
            "notification_type": "email",
            "order": 1,
            "party": {
                "trade_name": null,
                "address_zip_code": "36401-000",
                "form": null,
                "document": "324.005.740-90",
                "reference": "Praça da liberdade",
                "address_street": "Av Car",
                "id": 346164,
                "address_state": "MG",
                "name": "Seu nome aqui",
                "national_id": "00000000",
                "inserted_at": "2024-05-15T20:12:14",
                "birth_date": "1997-08-28",
                "contact_name": null,
                "reps": null,
                "organization": {
                    "id": 1199
                },
                "updated_at": "2024-05-15T20:12:14",
                "email": "[email protected]",
                "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"
            },
            "qualification": "Contratada",
            "signer_type": "sign",
            "updated_at": "2024-05-15T20:21:46",
            "viewed_at": null
        },
        {
            "company": {
                "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": 346165,
                "address_state": "MG",
                "name": "Razão social da empresa aqui",
                "national_id": null,
                "inserted_at": "2024-05-15T20:19:47",
                "birth_date": "1997-08-28",
                "contact_name": "Nome da pessoa responsável",
                "reps": [
                    {
                        "trade_name": null,
                        "address_zip_code": "36401-000",
                        "form": null,
                        "document": "324.005.740-90",
                        "reference": "Praça da liberdade",
                        "address_street": "Av Car",
                        "id": 346164,
                        "address_state": "MG",
                        "name": "Seu nome aqui",
                        "national_id": "00000000",
                        "inserted_at": "2024-05-15T20:12:14",
                        "birth_date": "1997-08-28",
                        "contact_name": null,
                        "reps": null,
                        "organization": {
                            "id": 1199
                        },
                        "updated_at": "2024-05-15T20:12:14",
                        "email": "[email protected]",
                        "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"
                    }
                ],
                "organization": {
                    "id": 1199
                },
                "updated_at": "2024-05-15T20:19:47",
                "email": null,
                "address_complement": "Complemento do endereço",
                "phone": "(99) 99999-9999",
                "contact_email": "[email protected]",
                "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
            },
            "contract": {
                "id": 176022
            },
            "email_viewed_at": null,
            "engine": "standard",
            "id": 345643,
            "inserted_at": "2024-05-15T20:20:06",
            "notification_type": "email",
            "order": 2,
            "party": {
                "trade_name": null,
                "address_zip_code": "36401-000",
                "form": null,
                "document": "324.005.740-90",
                "reference": "Praça da liberdade",
                "address_street": "Av Car",
                "id": 346164,
                "address_state": "MG",
                "name": "Seu nome aqui",
                "national_id": "00000000",
                "inserted_at": "2024-05-15T20:12:14",
                "birth_date": "1997-08-28",
                "contact_name": null,
                "reps": null,
                "organization": {
                    "id": 1199
                },
                "updated_at": "2024-05-15T20:12:14",
                "email": "[email protected]",
                "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"
            },
            "qualification": "Contratante",
            "signer_type": "sign",
            "updated_at": "2024-05-15T20:20:06",
            "viewed_at": null
        }
    ]
}

📝 O retorno desse endpoint será um array de objetos contendo todos os participantes associados aquele contrato em específico.


GET /contracts/{contract_id}/shares/{sharing_id}

Testar endpoint

Quando se cria uma share, ou seja, o processo de associar um participante ao contrato, nos é gerado um id para essa share, iremos utilizar esse valor no parâmetro dessa rota para buscar uma pessoa específica que foi associada ao contrato. Se ainda não houve criação da share, clique aqui para o passo a passo de como fazer.

NameDescription
contract_idid do contrato
sharing_idid da share criada após a associação do participante ao contrato

⚠️ Lembre-se de substituir as variáveis no parâmetro da rota pelos valores corretos.

Exemplo de resposta:

{
    "data": {
        "company": null,
        "contract": {
            "id": 176022
        },
        "email_viewed_at": null,
        "engine": "standard",
        "id": 345642,
        "inserted_at": "2024-05-15T20:12:31",
        "notification_type": "email",
        "order": 1,
        "party": {
            "trade_name": null,
            "address_zip_code": "36401-000",
            "form": null,
            "document": "324.005.740-90",
            "reference": "Praça da liberdade",
            "address_street": "Av Car",
            "id": 346164,
            "address_state": "MG",
            "name": "Seu nome aqui",
            "national_id": "00000000",
            "inserted_at": "2024-05-15T20:12:14",
            "birth_date": "1997-08-28",
            "contact_name": null,
            "reps": null,
            "organization": {
                "id": 1199
            },
            "updated_at": "2024-05-15T20:12:14",
            "email": "[email protected]",
            "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"
        },
        "qualification": "Contratada",
        "signer_type": "sign",
        "updated_at": "2024-05-15T20:21:46",
        "viewed_at": null
    }
}

Updated 6 months ago