assistants

List and retrieve email messages for a specific assistant.

get/v1/assistants/{assistant_id}/emails/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization
    • API key in cookie sessionid
    • API key in header X-Session-Token

Path parameters

assistant_idstring uuid required

Query parameters

direction'inbound' | 'outbound'

Filter by message direction.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

sincestring date-time

Only return messages created at or after this ISO 8601 datetime.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.