GET
/
v1
/
campaigns
List campaigns
curl --request GET \
  --url https://public-api.tryriot.com/v1/campaigns \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "completed_at": "2024-01-13T10:00:00.000000Z",
      "created_at": "2024-01-13T10:00:00.000000Z",
      "cycles": [
        {
          "created_at": "2024-01-13T10:00:00.000000Z",
          "ends_at": "2024-01-13T10:00:00.000000Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Batch 1",
          "starts_at": "2024-01-13T10:00:00.000000Z",
          "updated_at": "2024-01-13T10:00:00.000000Z"
        }
      ],
      "delivery": "one_off",
      "frequency": "daily",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "launched_at": "2024-01-13T10:00:00.000000Z",
      "name": "One-off campaign on 5 employees",
      "status": "active",
      "updated_at": "2024-01-13T10:00:00.000000Z",
      "workspace": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-item-limit
integer
default:50

Maximum number of items to return. Maximum value is 100.

Required range: 1 <= x <= 100
​
x-next-cursor
string

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Query Parameters

​
workspace_id
string<uuid>
required

ID of the workspace for which to retrieve campaigns

​
status
enum<string>[]

Filters campaigns based on their status. Accepts a comma-separated string of status values. Only campaigns matching the specified statuses will be included in the response.

​
created_after
string<date-time>

Filters campaigns based on their creation date. Only campaigns created after specified date (UTC) will be included in the response.

​
created_before
string<date-time>

Filters campaigns based on their creation date. Only campaigns created before specified date (UTC) will be included in the response.

Response

Campaigns list

The response is of type object.