Consultar Relacionamentos da Empresa

Esse endpoint é responsável por retornar os relacionamentos de Pessoas associadas a Empresa.

Parâmetros da URL

  • business_id:ID (uuid) da Empresa a consultar os relacionamentos já cadastrados.

Resposta

Se a consulta for realizada com sucesso, o retorno será um código 200 e um JSON contendo uma lista de relacionamentos da Empresa contendo com os seguintes campos:

  • id (string): O ID do relacionamento criado.
  • person (object): Objeto contendo os detalhes da Pessoa a ser relacionada com a Empresa.
    • id (string/uuid v4): ID da Pessoa gerado no momento do cadastro.
    • full_name (string): Nome da Pessoa.
    • taxpayer_id (string): CPF da Pessoa cadastrada.
  • type (string): O tipo do relacionamento que foi criado.
  • signer (boolean): Indicando se a pessoa é representante e pode assinar pela Empresa.
  • share (decimal): Indicando o percentual de participação no contrato social.
  • created_at (string): A data/hora que o relacionamento foi cadastrado.
  • version (integer): O número de controle da versão do cadastrado.
  • share (decimal): Valor da participação no contrato social.

Exemplo de Resposta

[{ "id": "05c9a470-cfdc-4df0-9153-c42ff96d4850", "type": "MANAGER", "person": { "id": "550b67da-96b7-438f-96bc-bcc08bb57021", "full_name": "Celcoin Sandbox", "taxpayer_id": "22635659060" }, "signer": true, "created_at": "2024-06-23T19:54:51.182928Z", "version": 0, "share": null }]
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Headers
string
Responses

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
English
Powered by Localize
Português (Brasil)