Agent Aliases
List aliases
Lists aliases. Results are paginated.
get/v2/agent_aliases
Query parameters
limitinteger
The maximum number of aliases to return.
page_keystring
The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.
filterstring
Example:support.*
A regular expression matched against alias names and descriptions to filter results.
enabledboolean
Example:true
Filter aliases by enabled status.
aliased_agent_keystring
A unique key that identifies an agent.
Example:customer_support
Returns only aliases whose routing policy points at the agent with this key.
Headers
Request-Timeoutinteger
The platform makes a best effort to complete the request in the specified seconds, or it times out.
Request-Timeout-Millisinteger
The platform makes a best effort to complete the request in the specified milliseconds, or it times out.
Response
List of aliases.
Changes
No recorded changes to this endpoint across all 13 revisions of this API.