Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url http://localhost:3000/v2/entities/{id}/social-assistance \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/entities/{id}/social-assistance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/entities/{id}/social-assistance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/entities/{id}/social-assistance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:3000/v2/entities/{id}/social-assistance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/entities/{id}/social-assistance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/entities/{id}/social-assistance")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"sourceDataset": "quod",
"observedAt": "2026-05-08T12:30:00.000Z",
"programs": [
{
"paymentHistory": [
{
"referenceDate": "2024-08-01",
"value": 1412,
"creditedAt": "2024-08-15T13:24:00Z"
}
],
"programName": "Bolsa Família",
"state": "TO",
"enrolledAt": "2025-03-17T15:21:14Z",
"paymentsCount": 12,
"totalPaid": 18000,
"firstPaymentDate": "2019-01-01",
"lastPaymentDate": "2024-12-01",
"lastPaymentValue": 1412
}
],
"totalIncome": 1518,
"totalAssistances": 1
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}curl --request GET \
--url http://localhost:3000/v2/entities/{id}/social-assistance \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/entities/{id}/social-assistance"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/entities/{id}/social-assistance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/entities/{id}/social-assistance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "http://localhost:3000/v2/entities/{id}/social-assistance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/entities/{id}/social-assistance")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/entities/{id}/social-assistance")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"sourceDataset": "quod",
"observedAt": "2026-05-08T12:30:00.000Z",
"programs": [
{
"paymentHistory": [
{
"referenceDate": "2024-08-01",
"value": 1412,
"creditedAt": "2024-08-15T13:24:00Z"
}
],
"programName": "Bolsa Família",
"state": "TO",
"enrolledAt": "2025-03-17T15:21:14Z",
"paymentsCount": 12,
"totalPaid": 18000,
"firstPaymentDate": "2019-01-01",
"lastPaymentDate": "2024-12-01",
"lastPaymentValue": 1412
}
],
"totalIncome": 1518,
"totalAssistances": 1
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}OAuth2 Authorization Code flow
CPF, CNPJ, or company id (cmp_*)
Maximum number of domain snapshots to return
Data de referência (YYYY-MM-DD)
Comma-separated optional response fields. Supports "summary.short", "summary.long", and "summary.mdx". Without summary.* the metadata.summary field is omitted.
Object type identifier
Array of results for current page
Show child attributes
Whether more results exist beyond this page
Show child attributes
Opaque cursor for next page. null if no more results.
Type of results (Notion-compatible)