Skip to main content
GET
List agent email aliases

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Query Parameters

alias
string

Globally unique short alias: 1–20 lowercase letters or digits with optional internal hyphens.

Required string length: 1 - 20
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
limit
integer
default:50

Maximum aliases per page, 1–200. Defaults to 50.

Required range: 1 <= x <= 200
cursor
string

Opaque nextCursor from this operation. Repeat every other query parameter unchanged; a cursor from a different query returns invalid_cursor.

Required string length: 1 - 8192
sortBy
enum<string>
default:alias

Response field used to sort aliases. The only supported value is alias.

Available options:
alias
order
enum<string>
default:asc

Alias sort direction: asc for ascending order (default), desc for descending order.

Available options:
asc,
desc

Response

Visible aliases and the next cursor, or null at exhaustion.

aliases
object[]
required

Alias configurations for this page, in the requested sort order.

nextCursor
string | null
required

Cursor for the next page, or null on the last page.