Starts an async export of the practice's contacts to CSV, optionally filtered as on the contacts list, one row per client the contact is linked to (a contact with no clients has one row). The columns match the contacts import, including each client's code, company number, internal reference and NI number to match on. Returns 201 Created with downloadUrl if the export completes within 10 seconds, or 202 Accepted with a Location header to poll for completion.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
Request Body
{
"includeHeaders": false,
"filter": {
"clientLinks": "...",
"hasEmail": false,
"isFromCompaniesHouse": false,
"hasPortalAccess": false
}
}
Responses
201 Created
202 Accepted
400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden