Visualizando

Consultando um cliente

GET /v1/organization/CLIENT_ID/companies/CODIGO DO CLIENTE

Endpoint para consultar um cliente.

Todos os endpoints, necessitarão dos 2 tokens no Header e deverá ser passado na URL o CLIENT_ID. Esse assunto foi tratado em Primeiros Passos, caso não tenha este código, acione o time de suporte.

Headers:

Name	Value
Content-Type	application/json
Accept	application/json
Authorization	Bearer <token de Autenticação>
x-spro-authorization	<token de Autorização>

Body: Vazio

URL Parameters: exemplo: /v1/organization/CLIENT_ID/companies/CODIGO DO CLIENTE

Campo	Exemplo de Valor	Descrição
CLIENT_ID	01jawvcvfahk52qsaerzfa0tyj	Código da sua empresa (passado pelo time de integração após o setup). Detalhado em: Primeiros passos.
CODIGO DO CLIENTE	01hsk7nf8s05cgr9ewyx6xj39c	Código do cliente (campo ulid do cadastro dele)

Response:

200

{
    "company": {
        "id": 1,
        "ulid": "01hsk7nf8s05cgr9ewyx6xj39c",
        "status": true,
        "type": "J",
        "registration_number": "58312998000140",
        "alias": "Barreto e Rodrigues e Filhos",
        "name": "Barreto e Rodrigues e Filhos",
        "email": "[e-mail]",
        "phone": "(87) 90410-2583",
        "whatsapp": "(22) 98676-2512",
        "country_id": 846,
        "state_id": 397,
        "city_id": 196,
        "address": "Largo Renan, 2. Bloco C",
        "number": "68111",
        "complement": "Bc. 8 Ap. 47",
        "neighborhood": "Sul",
        "postal_code": "95765-846",
        "customers": [
            {
                "id": 1,
                "ulid": "01hsf065qevt1176yz3cgtk227",
                "status": true,
                "registration_number": "81282527045",
                "name": "Michael Keenan Franco",
                "email": "[e-mail]",
                "phone": "(62)98178-0000",
                "whatsapp": "(62)98178-0000",
                "bird_id": {
                    "is_valid": false,
                    "verified_at": "2024-04-23 15:09:50"
                },
                "videoconference": {
                    "verification": false,
                    "link": null
                }
            },
            {
                "id": 2,
                "ulid": "01vvf062qevt1176yf7cgtk001",
                "status": true,
                "registration_number": "85631763583",
                "name": "Kiera Eli Fernandes",
                "email": "[e-mail]",
                "phone": "(00)00000-0000",
                "whatsapp": "(00)00000-0000",
                "bird_id": {
                    "is_valid": false,
                    "verified_at": "2024-04-23 15:09:50"
                },
                "videoconference": {
                    "verification": false,
                    "link": null
                }
            }
        ]
    }
}

Note que a estrutura: customers é um array com todos os representantes legais deste cliente.

Note que dentro da estrutura dos representantes legais (customers) existem os dados sobre birdid e videoconferencia. Mais detalhes sobre como esses campos são preenchidos aqui.

401

403

404