get
https://api.duodeal.app/api/customer-companies
Retrieves a paginated list of all customer companies (B2B clients).
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number for pagination (default: 1) |
limit | integer | No | Number of items per page (default: 50) |
order | string | No | Field to sort by (default: id) |
direction | string | No | Sort direction: asc or desc (default: desc) |
Response Fields
| Field | Type | Description |
|---|---|---|
id | integer | Customer company unique identifier |
name | string | Company legal name |
siret | string | SIRET number (French business ID) |
vatNumber | string | VAT identification number |
tradeName | string | Commercial/trade name |
address | object | Company address (see Address object below) |
archived | boolean | Whether the customer company is archived |
isDeletable | boolean | Whether the company can be deleted (no linked customers) |
customFields | object | Custom field values |
createdAt | datetime | Creation timestamp |
updatedAt | datetime | Last update timestamp |
Address Object
| Field | Type | Description |
|---|---|---|
country | string | Country code (e.g., FR, US) |
address | string | Street address |
state | string | State/region |
postCode | string | Postal code |
city | string | City name |
Filtering
This endpoint supports advanced filtering. See the Filter System Documentation for the complete list of operators and usage examples.
Quick examples:
?filters[name][contains]=Tech
?filters[siret][startsWith]=123
?filters[archived][eq]=false
?filters[customFields.sector][eq]=ITResponse
200 OK: Returns paginated list of customer companies401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Successful response
Unauthorized