Get Segment

This endpoint returns a single segment.

Important Notes

  • Requires segments:read scope.
  • 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

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks segments:read scope.
403forbiddencompany_not_enabledThe company is not enabled to read Cortex data through this API. Contact AgendaPro to enable it; retrying does not help.
404not_foundsegmentSegment not found, or it belongs to another company.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
502upstream_unavailableupstream_misconfiguredAgendaPro's internal connection to Cortex is misconfigured. It is not a problem with your API key; retry later or contact support.
502upstream_unavailableupstream_errorCortex answered an error. Retry the same request later.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Segment unique identifier (Cortex).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json