OMomni
AI Routines

List AI Routines

Changed on

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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/routines
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

cursorstring
Example:eyJpZCI6IjEyMzQ1In0

Cursor for pagination from previous response nextCursor.

pageSizeinteger
Example:20

Number of results per page

sortDirection'asc' | 'desc'

Direction for sorting results:

  • asc - Ascending order (A-Z, 0-9)
  • desc - Descending order (Z-A, 9-0)
sortFieldstring

Field to sort results by

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

List of AI Routines

Example response

{
  "records": [
    {
      "condition": {
        "conditionPrompt": "there are failed orders",
        "conditionType": "RESULTS_PRESENT"
      },
      "destination": {
        "recipientEmails": [
          "blob.ross@blobsrus.com",
          "blob.the.builder@blobsrus.com"
        ],
        "type": "email",
        "userGroupIds": [
          "X9kQ2mPz"
        ]
      },
      "lastRun": {
        "label": "Delivered",
        "state": "COMPLETE"
      }
    }
  ]
}

Changes

  • 43290040f88fRevision changes
    • breaking

      for the query request parameter sortDirection, default value desc was removed

    • breaking

      added to the // response property oneOf list for the response status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id aiRoutinesList removed and replaced with routinesList

    • info

      added email slack webhook discriminator mapping keys to the // response property for the response status

    • info

      removed from the // response property oneOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property to the response with the status