get
https://connect.agendapro.com/v3/segments
This endpoint returns the company's Cortex CRM segments, including the system segment used for reminders (system_kind: reminder).
Important Notes
- Requires
segments:readscope. - Served by Cortex, AgendaPro's conversational agent. Phones are returned exactly as stored (e.g.
+521…for numbers that came from WhatsApp in Mexico); they are not normalized.
Errors Dictionary
| Status | Error | Detail | Description |
|---|---|---|---|
| 400 | invalid_format | limit | limit is not an integer. |
| 400 | invalid_range | limit | limit is out of the allowed range. |
| 400 | invalid_format | cursor | cursor is not a cursor returned by this list. |
| 400 | invalid_params | params | Another parameter is invalid. |
| 401 | unauthorized | invalid_api_key | Missing or invalid Bearer token. |
| 401 | unauthorized | api_config_inactive | API access is inactive for this company. |
| 403 | forbidden | scope_denied | API key lacks segments:read scope. |
| 403 | forbidden | company_not_enabled | The company is not enabled to read Cortex data through this API. Contact AgendaPro to enable it; retrying does not help. |
| 429 | rate_limited | burst_limit_exceeded | Per-minute request limit exceeded. |
| 429 | rate_limited | daily_quota_exceeded | Daily request quota exceeded. |
| 502 | upstream_unavailable | The upstream service is unavailable. | |
| 502 | upstream_unavailable | upstream_misconfigured | AgendaPro's internal connection to Cortex is misconfigured. It is not a problem with your API key; retry later or contact support. |
| 502 | upstream_unavailable | upstream_error | Cortex answered an error. Retry the same request later. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…