Listando

Filtrando os clientes

GET /v1/organization/CLIENT_ID/companies?filter=CPF/CNPJ ou Nome da Empresa&order[column]=name&order[direction]=asc&customers=all

Neste endpoint você consegue listar todos os seus clientes filtrando pelo CNPJ ou Nome da empresa e representantes legais. É possivel também ordenar o retorno da consulta pelo nome do cliente, status e tipo (pessoa Física ou pessoa Juridica)

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>

URL Parameters: exemplo: /organization/CLIENT_ID/?filter=CPF/CNPJ ou Nome da Empresa&order[column]=name&order[direction]=asc

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.
filter	Fiserv company	Pode passar o nome da empresa (ou parte dela) ou o CPF/CNPJ do cliente (ou parte dele)
order[column]	name	pode solicitar a ordenação pelos campos: name (Nome da Empresa), status (true=ativo, false=inativo), type (F=Pessoa Fisica, J=Pessoa Juridica)
order[direction]	asc	Pode ser asc ou desc
customers	all	É possivel passar um dos parâmetros: all (todos os representantes legais) with_bird_id (somente os que tem BirdID) without_bird_id (somente os que não tem BirdID)

Body: vazio

Response:

201

{
"data": [
		{
			"id": 133,
			"ulid": "01jawvcvfahk52qsaerzfa0tyj",
			"status": true,
			"type": "J",
			"registration_number": "60307050000148",
			"alias": "Fiserv Inc. BV",
			"name": "Fiserv Inc. BV",
			"email": "kobe.christian.sá@fiservincbv.com",
			"phone": "(00) 00000-0000",
			"whatsapp": "(22) 98676-2512",
			"country_id": 1058,
			"state_id": 52,
			"city_id": 5208707,
			"address": "Largo Renan, 2. Bloco C",
			"number": "68111",
			"complement": "Bc. 8 Ap. 47",
			"neighborhood": "Sul",
			"postal_code": "95765-846",
			"all_customers_has_birdid": null,
			"customers": [
				{
					"id": 167,
					"ulid": "01jawvcx9v1d0kxvjzhde7w27k",
					"status": true,
					"registration_number": "23716155527",
					"name": "Kobe Christian Sá",
					"email": "[e-mail]",
					"phone": "(0)00000-0000",
					"whatsapp": "(00)99999-9999",
					"bird_id": {
						"is_valid": true,
						"verified_at": "2024-10-23 11:09:55"
					},
					"videoconference": {
						"verification": false,
						"link": null
					}
				}
			]
		},
	],
	"links": {
		"first": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j60cef7q67a1yqszpmrrsdkf\/companies?page=1",
		"last": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j60cef7q67a1yqszpmrrsdkf\/companies?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"links": [
			{
				"url": null,
				"label": "« Anterior",
				"active": false
			},
			{
				"url": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j60cef7q67a1yqszpmrrsdkf\/companies?page=1",
				"label": "1",
				"active": true
			},
			{
				"url": null,
				"label": "Próximo »",
				"active": false
			}
		],
		"path": "https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01j60cef7q67a1yqszpmrrsdkf\/companies",
		"per_page": 10,
		"to": 6,
		"total": 6
	}
}

Os dados retornam paginados

401

403

404

422