ReferenceEndpoints
List agents
The agent directory: codes, status, current contract, activities, supervisors and agent custom fields.
GET
/api/v1/agentsParameters
| Parameter | Required | Description |
|---|---|---|
activity | No | Activity codes as shown on the activity (or ids), comma-separated. Leave it out for every activity the key can read. |
status | No | Agents: active (default), terminated or all. |
limit | No | Rows per page, 1 to 1000. Default 500 for JSON. A CSV without limit holds every row. |
cursor | No | The next page: next_cursor from the previous response. |
Example
curl "/api/v1/agents?activity=AC-0001" \
-H "Authorization: Bearer $PLANIFIZER_API_KEY"{
"data": [
{
"id": "e177c03f-…",
"code": "AG-0042",
"status": "active",
"country": "BJ",
"timezone": "Africa/Porto-Novo",
"contract": {
"id": "9b1d2e3f-…",
"type": "Full time 40h",
"weekly_hours": 40,
"start": "2026-01-05",
"end": null
},
"activities": [
"AC-0006"
],
"supervisors": [
{
"id": "c40f8813-…"
}
],
"custom": {
"matricule": "M-1042"
}
}
],
"meta": {
"status": "active",
"activities": "all",
"personal_details": false,
"count": 1,
"total": 64,
"limit": 500,
"next_cursor": null
}
}