v1
latestOpenAPI 3.1.02026-07-24890394.2 KBListar sócios - PJ
Lista todos os sócios PJ de determinado onboarding.
get/clients/{onboarding_id}/partners/companies
Path parameters
onboarding_idstring required
Id da solicitação de cadastro.
Query parameters
p[per_page]string
Quantidade de itens para retornar por página.
p[page]string
Página a ser carregada.
q[parentCompanyIdEq]integer
Parent company id é igual a.
q[documentNumberContNumbers]integer
CNPJ da empresa igual a.
q[nameCont]string
Nome fantasia da empresa contém ou é igual a.
q[companyNameCont]string
Razão social da empresa contém ou é igual a.
q[emailCont]string
E-mail da empresa contém ou é igual a.
Response
200
Example response
{
"data": [
{
"id": "e0749af5-0240-4751-8c47-65b93b85a1a0",
"type": "company",
"attributes": {
"documentNumber": "43437760000173",
"parentCompanyId": "0",
"name": "Dunder Mifflin Paper Company",
"companyName": "Dunder Mifflin",
"email": "david.wallace@dunder-mifflin.paper",
"shareCapital": "0.0",
"sharePercent": "50.0"
}
}
],
"meta": {
"pagination": {
"currentPage": 1,
"perPage": 25,
"totalPages": 1,
"totalCount": 1
}
}
}