v4

OpenAPI 3.1.02026-08-01207318738.7 KB

AI Routines

List routines

List 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. Organization API keys can pass ?userId=<membershipId> to list routines for a specific organization member.

get/api/v1/ai/routines

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0

Cursor for pagination (from previous response nextCursor)

pageSizeinteger

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

Example:20

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

sortDirection'asc' | 'desc'

Sort direction for results

Example:desc

Sort direction for results

sortFieldstring

Field to sort results by

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Response

Paginated list of routines.

Example response

{
  "records": [
    {
      "destination": {
        "recipientEmails": [
          "alice@example.com",
          "bob@example.com"
        ],
        "type": "email",
        "userGroupIds": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "lastRun": {
        "label": "Delivered",
        "state": "COMPLETE"
      }
    }
  ]
}