Companies
Filter companies
Query companies using flexible filter criteria with AND/OR logic.
By default, only non-deleted companies are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.
post/companies/filter
Request body
Example request
{
"filter": {
"and": [
{
"invoiceOnly": {
"equalTo": false
}
},
{
"name": {
"includes": "Inc"
}
}
]
},
"pageSize": 50
}Response
Filtered companies with pagination
Example response
{
"data": [
{
"object": "COMPANY",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Logistics Inc",
"addressLine1": "123 Main St",
"addressLine2": "Suite 400",
"city": "Chicago",
"country": "USA",
"fax": "+1-555-0123",
"invoiceVerbiage": "Please remit payment within 30 days",
"primaryContactName": "John Smith",
"primaryContactEmail": "john.smith@acmelogistics.com",
"primaryContactPhone": "+1-555-0100",
"createdBy": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-USER-12345",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1-555-123-4567",
"phoneExt": "123",
"status": "ACTIVE",
"avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"key": "ERP-COMPANY-ACME-001",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
],
"pageInfo": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}