Listar pessoas vinculadas ao parceiro financeiro - Juridiq Software

Listar pessoas vinculadas ao parceiro financeiro

curl --request GET \
  --url https://api.juridiq.com.br/financial/partners/{id}/people \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/financial/partners/{id}/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/financial/partners/{id}/people",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/financial/partners/{id}/people"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/financial/partners/{id}/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "document": "<string>",
      "personType": "<string>",
      "personOrigin": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "partnerLinkedAt": "<string>",
      "linkedLawsuitCount": 123
    }
  ],
  "totalItems": 123,
  "totalPages": 123,
  "page": 123,
  "limit": 123
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

GET

/

financial

/

partners

/

{id}

/

people

Listar pessoas vinculadas ao parceiro financeiro

curl --request GET \
  --url https://api.juridiq.com.br/financial/partners/{id}/people \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/financial/partners/{id}/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/financial/partners/{id}/people",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/financial/partners/{id}/people"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/financial/partners/{id}/people")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "document": "<string>",
      "personType": "<string>",
      "personOrigin": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "partnerLinkedAt": "<string>",
      "linkedLawsuitCount": 123
    }
  ],
  "totalItems": 123,
  "totalPages": 123,
  "page": 123,
  "limit": 123
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Path Parameters

id

string<uuid>

required

ID do parceiro

Query Parameters

page

string

Página (default 1)

limit

string

Itens por página (default 30)

search

string

Busca por nome, documento, e-mail ou telefone

personOrigin

enum<string>

Filtro por origem da pessoa

Available options:

cliente,

parte adversa

orderByField

enum<string>

Campo de ordenação (default partnerLinkedAt)

Available options:

partnerLinkedAt,

name

orderBy

enum<string>

Direção (default desc)

Available options:

asc,

desc

Response

Default Response

data

object[]

required

Pessoas vinculadas ao parceiro

Show child attributes

totalItems

number

required

Total de registros

totalPages

number

required

Total de páginas

page

number

required

Página atual

limit

number

required

Itens por página