v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

AI Routines

List AI Routines

List AI Routines for the calling user, newest first. Includes routines paused by the owner or disabled by Omni, but excludes deleted routines.

Use pageInfo.nextCursor from one response as the cursor query parameter on the next request.

get/v1/ai/routines

Query parameters

cursorstring

Example:eyJpZCI6IjEyMzQ1In0

Cursor for pagination from previous response nextCursor

pageSizeinteger

Example:20

Number of results per page (1-100, integer)

sortDirection'asc' | 'desc'

Example:desc

Sort direction for results

sortFieldstring

Field to sort results by

userIdstring uuid

Requires an Organization API key. Target user membership ID.

Response

List of AI Routines

Example response

{
  "records": [
    {
      "destination": {
        "recipientEmails": [
          "blob.ross@blobsrus.com",
          "blob.the.builder@blobsrus.com"
        ],
        "type": "email",
        "userGroupIds": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "lastRun": {
        "label": "Delivered",
        "state": "COMPLETE"
      }
    }
  ]
}