Entities API
API endpoints for entity data.
Entities API
This documentation is currently being developed. Check back soon for complete content.
List Entities
GET /v1/entitiesParameters
| Parameter | Type | Description |
|---|---|---|
type | string | Entity type (customer, vendor) |
search | string | Search query |
Response
{
"data": [
{
"id": "ent_123",
"type": "customer",
"name": "Acme Corp",
"email": "contact@acme.com"
}
],
"meta": {
"total": 100
}
}Get Entity
GET /v1/entities/:idResponse
{
"data": {
"id": "ent_123",
"type": "customer",
"name": "Acme Corp",
"addresses": [...],
"contacts": [...]
}
}