v1
latestOpenAPI 3.1.02026-07-24890394.2 KBListar sócios - PF
Lista todos os sócios PF de determinado onboarding.
get/clients/{onboarding_id}/partners/people
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.
s[]'asc' | 'desc'
Ordena os resultados usando o campo desejado, pode ser asc (crescente) ou desc (decrescente).
q[idEq]string
Id da solicitação de cadastros igual a.
q[parentCompanyIdEq]string
Parent company id igual a.
q[documentNumberContNumbers]string
CPF da empresa igual a.
q[nameCont]string
Nome completo do sócio contém ou é igual a.
q[emailCont]string
E-mail da empresa contém ou é igual a.
Response
200
Example response
{
"data": [
{
"id": "28295044-5d47-419b-a8ab-bb904bc7ce41",
"type": "person",
"attributes": {
"documentNumber": "12345679891",
"parentCompanyId": "0",
"name": "Dwight Kurt Schrute",
"email": "dwight.schrute@gmail.com",
"shareCapital": "95.5",
"sharePercent": "100.0"
}
}
],
"meta": {
"pagination": {
"currentPage": 1,
"perPage": 25,
"totalPages": 1,
"totalCount": 1
}
}
}