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/targets/{document} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/targets/{document}"
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/targets/{document}', 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/targets/{document}",
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/targets/{document}"
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/targets/{document}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/targets/{document}")
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": [
{
"document": "<string>",
"legalName": "<string>",
"tradeName": "<string>",
"isHeadQuarter": true,
"address": {
"city": "<string>",
"state": "<string>"
},
"status": {
"code": "<string>",
"date": "<string>"
},
"activityStartDate": "<string>",
"page": {
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"kind": "report",
"title": "<string>",
"agent": {
"type": "none"
},
"assignee": [
{
"type": "user_id",
"user_id": "<string>"
}
],
"targets": [
{
"type": "company",
"company": {
"id": "cmp_abc123",
"document": "12345678000190",
"tradeName": "Acme Corp",
"legalName": "Acme Ltda",
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
}
}
}
],
"permissions": {
"allow": [
"<string>"
],
"deny": [
"<string>"
],
"ask": [
"<string>"
]
},
"files": [
{
"type": "file_upload",
"name": "<string>",
"file_upload": {
"id": "<string>"
}
}
],
"pipelines": {},
"properties": {},
"relations": {},
"summary": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
},
"agentFileId": "<string>",
"content": {
"rich_text": [
{
"type": "text",
"text": {
"content": "<string>",
"link": {
"url": "<string>"
}
},
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "<string>",
"trend": "up"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"type": "page_id",
"page_id": "<string>"
},
"usage": {
"input": 123,
"output": 123,
"total": 123,
"cacheReadInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheCreationEphemeral1hInputTokens": 123,
"cacheCreationEphemeral5mInputTokens": 123,
"totalInputTokens": 123,
"durationSeconds": 123,
"activeSeconds": 123,
"claudeUsage": {},
"claudeStats": {}
},
"runSessionId": {
"object": "session",
"id": "<string>",
"status": "provisioning",
"userId": "<string>"
},
"url": "<string>"
},
"companyId": "<string>",
"shareholders": [
{
"name": "<string>",
"document": "<string>",
"qualification": "<string>",
"role": "<string>",
"startDate": "<string>"
}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"type": "<string>"
}Search for a target (company, group, or person) by document number. Returns target data AND existing page (if any) for each target.
Does NOT create pages - only returns data + existing page.
curl --request GET \
--url http://localhost:3000/v2/targets/{document} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/targets/{document}"
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/targets/{document}', 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/targets/{document}",
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/targets/{document}"
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/targets/{document}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/targets/{document}")
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": [
{
"document": "<string>",
"legalName": "<string>",
"tradeName": "<string>",
"isHeadQuarter": true,
"address": {
"city": "<string>",
"state": "<string>"
},
"status": {
"code": "<string>",
"date": "<string>"
},
"activityStartDate": "<string>",
"page": {
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"kind": "report",
"title": "<string>",
"agent": {
"type": "none"
},
"assignee": [
{
"type": "user_id",
"user_id": "<string>"
}
],
"targets": [
{
"type": "company",
"company": {
"id": "cmp_abc123",
"document": "12345678000190",
"tradeName": "Acme Corp",
"legalName": "Acme Ltda",
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
}
}
}
],
"permissions": {
"allow": [
"<string>"
],
"deny": [
"<string>"
],
"ask": [
"<string>"
]
},
"files": [
{
"type": "file_upload",
"name": "<string>",
"file_upload": {
"id": "<string>"
}
}
],
"pipelines": {},
"properties": {},
"relations": {},
"summary": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"icon": {
"type": "emoji",
"emoji": "page_icon",
"external": {
"url": "https://example.com/image.jpg"
},
"file_upload": {
"id": "fu_abc123"
},
"domain": "acme.com",
"file": {
"url": "https://s3.amazonaws.com/...",
"expiryTime": "2024-01-15T10:30:00.000Z"
},
"lucide": "file-text",
"brand": "github",
"dicebear": {
"style": "notionists-neutral",
"seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
"backgroundColor": "b6e3f4,b6e3f4",
"options": {
"brows": "<string>",
"eyes": "<string>",
"glasses": "<string>",
"lips": "<string>",
"nose": "<string>",
"flip": true,
"rotate": 123,
"scale": 123,
"radius": 123,
"size": 123,
"backgroundType": "solid",
"backgroundRotation": [
123
],
"translateX": 123,
"translateY": 123,
"clip": true,
"randomizeIds": true
}
},
"background": "blue",
"empty": true,
"updatedBy": "dataset:empresas"
},
"agentFileId": "<string>",
"content": {
"rich_text": [
{
"type": "text",
"text": {
"content": "<string>",
"link": {
"url": "<string>"
}
},
"annotations": {
"bold": true,
"italic": true,
"strikethrough": true,
"underline": true,
"code": true,
"color": "<string>",
"trend": "up"
},
"plain_text": "<string>",
"href": "<string>"
}
],
"color": "<string>"
},
"parent": {
"type": "page_id",
"page_id": "<string>"
},
"usage": {
"input": 123,
"output": 123,
"total": 123,
"cacheReadInputTokens": 123,
"cacheCreationInputTokens": 123,
"cacheCreationEphemeral1hInputTokens": 123,
"cacheCreationEphemeral5mInputTokens": 123,
"totalInputTokens": 123,
"durationSeconds": 123,
"activeSeconds": 123,
"claudeUsage": {},
"claudeStats": {}
},
"runSessionId": {
"object": "session",
"id": "<string>",
"status": "provisioning",
"userId": "<string>"
},
"url": "<string>"
},
"companyId": "<string>",
"shareholders": [
{
"name": "<string>",
"document": "<string>",
"qualification": "<string>",
"role": "<string>",
"startDate": "<string>"
}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"type": "<string>"
}OAuth2 Authorization Code flow
Document number (8, 11, or 14 chars)
"12345678901234"
Optional comma-separated list of fields to include (e.g., "shareholders")
"shareholders"
Target search results with existing pages
Object type identifier
Array of target search candidates
Show child attributes
Whether more results exist beyond this page
Opaque cursor for next page. null if no more results.
Type of results (Notion-compatible)