> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chevre.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Chevre REST API Endpoints — Automations Reference

> List, create, and manage automations and inspect their run history using the Chevre REST API. Supports event-driven and scheduled automation types.

Automations let you define rules that execute actions automatically in response to events or on a schedule. Each automation belongs to a project and consists of a trigger (what starts it) and one or more actions (what it does). Use the endpoints below to manage automations and inspect their run history. All requests require your API key in the `Authorization` header as `Bearer <your_api_key>`.

***

## List automations

**`GET`** **`https://api.chevre.io/v1/automations`**

Returns a paginated list of all automations accessible to the authenticated API key, across all projects the key has access to. Results are ordered by creation date, newest first. To retrieve automations scoped to a specific project, use the [List automations in a project](#list-automations-in-a-project) endpoint.

### Query parameters

<ParamField query="page" type="integer" default="1">
  The page number to retrieve. Must be a positive integer.
</ParamField>

<ParamField query="per_page" type="integer" default="20">
  The number of automations to return per page. Minimum is `1`, maximum is `100`.
</ParamField>

<ParamField query="project_id" type="string">
  Filter results to only automations belonging to the specified project (e.g. `proj_01ABC`). Optional.
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.chevre.io/v1/automations?page=1&per_page=20" \
    --header "Authorization: Bearer <your_api_key>" \
    --header "Accept: application/json"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.chevre.io/v1/automations",
      params={"page": 1, "per_page": 20},
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.chevre.io/v1/automations?page=1&per_page=20",
    {
      headers: {
        Authorization: "Bearer <your_api_key>",
        Accept: "application/json",
      },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### Example response

```json 200 theme={null}
{
  "data": [
    {
      "id": "auto_01GHI",
      "project_id": "proj_01ABC",
      "name": "New Task Alert",
      "type": "event",
      "enabled": true,
      "trigger": {
        "event": "task.created",
        "filters": []
      },
      "created_at": "2024-03-10T12:00:00Z",
      "updated_at": "2024-05-01T09:45:00Z"
    },
    {
      "id": "auto_02JKL",
      "project_id": "proj_01ABC",
      "name": "Weekly Digest",
      "type": "scheduled",
      "enabled": true,
      "trigger": {
        "schedule": "0 9 * * 1"
      },
      "created_at": "2024-04-01T08:00:00Z",
      "updated_at": "2024-04-01T08:00:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 20
  }
}
```

### Response fields

<ResponseField name="data" type="array">
  An array of automation objects.

  <Expandable title="automation object">
    <ResponseField name="id" type="string">
      The unique identifier for the automation, prefixed with `auto_`.
    </ResponseField>

    <ResponseField name="project_id" type="string">
      The ID of the project this automation belongs to.
    </ResponseField>

    <ResponseField name="name" type="string">
      The display name of the automation.
    </ResponseField>

    <ResponseField name="type" type="string">
      The automation type. Either `"event"` (triggered by an event) or `"scheduled"` (triggered on a cron schedule).
    </ResponseField>

    <ResponseField name="enabled" type="boolean">
      Whether the automation is currently active. Disabled automations do not execute.
    </ResponseField>

    <ResponseField name="trigger" type="object">
      The trigger configuration. For `event` automations, contains an `event` name and optional `filters`. For `scheduled` automations, contains a `schedule` cron expression.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the automation was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of the most recent update.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="meta" type="object">
  Pagination metadata for the response.

  <Expandable title="meta object">
    <ResponseField name="total" type="integer">
      Total number of automations accessible to your API key.
    </ResponseField>

    <ResponseField name="page" type="integer">
      The current page number returned.
    </ResponseField>

    <ResponseField name="per_page" type="integer">
      The number of results per page used for this response.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## List automations in a project

**`GET`** **`https://api.chevre.io/v1/projects/{project_id}/automations`**

Returns all automations defined in the specified project. Results are ordered by creation date, newest first.

### Path parameters

<ParamField path="project_id" type="string" required>
  The unique identifier of the project whose automations you want to list (e.g. `proj_01ABC`).
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.chevre.io/v1/projects/proj_01ABC/automations" \
    --header "Authorization: Bearer <your_api_key>" \
    --header "Accept: application/json"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.chevre.io/v1/projects/proj_01ABC/automations",
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.chevre.io/v1/projects/proj_01ABC/automations",
    {
      headers: {
        Authorization: "Bearer <your_api_key>",
        Accept: "application/json",
      },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### Example response

```json 200 theme={null}
{
  "data": [
    {
      "id": "auto_01GHI",
      "project_id": "proj_01ABC",
      "name": "New Task Alert",
      "type": "event",
      "enabled": true,
      "trigger": {
        "event": "task.created",
        "filters": []
      },
      "created_at": "2024-03-10T12:00:00Z",
      "updated_at": "2024-05-01T09:45:00Z"
    },
    {
      "id": "auto_02JKL",
      "project_id": "proj_01ABC",
      "name": "Weekly Digest",
      "type": "scheduled",
      "enabled": true,
      "trigger": {
        "schedule": "0 9 * * 1"
      },
      "created_at": "2024-04-01T08:00:00Z",
      "updated_at": "2024-04-01T08:00:00Z"
    }
  ]
}
```

### Response fields

<ResponseField name="data" type="array">
  An array of automation objects for the project.

  <Expandable title="automation object">
    <ResponseField name="id" type="string">
      The unique identifier for the automation, prefixed with `auto_`.
    </ResponseField>

    <ResponseField name="project_id" type="string">
      The ID of the project this automation belongs to.
    </ResponseField>

    <ResponseField name="name" type="string">
      The display name of the automation.
    </ResponseField>

    <ResponseField name="type" type="string">
      The automation type. Either `"event"` (triggered by an event) or `"scheduled"` (triggered on a cron schedule).
    </ResponseField>

    <ResponseField name="enabled" type="boolean">
      Whether the automation is currently active. Disabled automations do not execute.
    </ResponseField>

    <ResponseField name="trigger" type="object">
      The trigger configuration. For `event` automations, contains an `event` name and optional `filters`. For `scheduled` automations, contains a `schedule` cron expression.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the automation was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of the most recent update.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Create an automation

**`POST`** **`https://api.chevre.io/v1/automations`**

Creates a new automation in the specified project. You can create both event-driven and scheduled automations. An automation must have at least one action defined to be valid.

### Request body

<ParamField body="project_id" type="string" required>
  The ID of the project to create the automation in.
</ParamField>

<ParamField body="name" type="string" required>
  The display name for the automation. Must be between 1 and 255 characters.
</ParamField>

<ParamField body="type" type="string" required>
  The type of automation. Accepted values:

  * `"event"` — fires when a specified event occurs in the project.
  * `"scheduled"` — fires on a cron schedule.
</ParamField>

<ParamField body="enabled" type="boolean" default="true">
  Whether the automation should be active immediately after creation. Set to `false` to create the automation in a paused state.
</ParamField>

<ParamField body="trigger" type="object" required>
  The trigger configuration for the automation.

  <Expandable title="trigger fields">
    <ParamField body="event" type="string">
      For `type: "event"` automations. The event name that fires this automation (e.g. `"task.created"`, `"task.completed"`, `"member.invited"`).
    </ParamField>

    <ParamField body="filters" type="array">
      For `type: "event"` automations. An optional array of filter conditions that must all match for the automation to fire. Each filter object contains `field`, `operator`, and `value` keys.
    </ParamField>

    <ParamField body="schedule" type="string">
      For `type: "scheduled"` automations. A cron expression defining the schedule (e.g. `"0 9 * * 1"` for every Monday at 9 AM). Uses the workspace timezone.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="actions" type="array" required>
  An ordered list of actions to execute when the automation fires. Each action must include a `type` and a `config` object specific to that action type.

  <Expandable title="action fields">
    <ParamField body="type" type="string">
      The action type. Supported values include `"send_slack_message"`, `"send_email"`, `"create_task"`, `"update_task"`, and `"call_webhook"`.
    </ParamField>

    <ParamField body="config" type="object">
      Configuration specific to the action type. For example, `send_slack_message` requires `channel` and `message` fields. Template variables in the form `{{resource.field}}` are supported.
    </ParamField>
  </Expandable>
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request POST \
    --url "https://api.chevre.io/v1/automations" \
    --header "Authorization: Bearer <your_api_key>" \
    --header "Content-Type: application/json" \
    --data '{
      "project_id": "proj_01ABC",
      "name": "New Task Alert",
      "type": "event",
      "enabled": true,
      "trigger": {
        "event": "task.created",
        "filters": []
      },
      "actions": [
        {
          "type": "send_slack_message",
          "config": {
            "channel": "#general",
            "message": "New task created: {{task.name}}"
          }
        }
      ]
    }'
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://api.chevre.io/v1/automations",
      json={
          "project_id": "proj_01ABC",
          "name": "New Task Alert",
          "type": "event",
          "enabled": True,
          "trigger": {
              "event": "task.created",
              "filters": [],
          },
          "actions": [
              {
                  "type": "send_slack_message",
                  "config": {
                      "channel": "#general",
                      "message": "New task created: {{task.name}}",
                  },
              }
          ],
      },
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.chevre.io/v1/automations", {
    method: "POST",
    headers: {
      Authorization: "Bearer <your_api_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      project_id: "proj_01ABC",
      name: "New Task Alert",
      type: "event",
      enabled: true,
      trigger: {
        event: "task.created",
        filters: [],
      },
      actions: [
        {
          type: "send_slack_message",
          config: {
            channel: "#general",
            message: "New task created: {{task.name}}",
          },
        },
      ],
    }),
  });
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### Example response

```json 201 theme={null}
{
  "data": {
    "id": "auto_01GHI",
    "project_id": "proj_01ABC",
    "name": "New Task Alert",
    "type": "event",
    "enabled": true,
    "trigger": {
      "event": "task.created",
      "filters": []
    },
    "actions": [
      {
        "type": "send_slack_message",
        "config": {
          "channel": "#general",
          "message": "New task created: {{task.name}}"
        }
      }
    ],
    "created_at": "2024-06-01T14:22:00Z",
    "updated_at": "2024-06-01T14:22:00Z"
  }
}
```

### Response fields

<ResponseField name="data" type="object">
  The newly created automation object.

  <Expandable title="automation object">
    <ResponseField name="id" type="string">
      The unique identifier for the automation, prefixed with `auto_`.
    </ResponseField>

    <ResponseField name="project_id" type="string">
      The ID of the project this automation belongs to.
    </ResponseField>

    <ResponseField name="name" type="string">
      The display name of the automation.
    </ResponseField>

    <ResponseField name="type" type="string">
      The automation type: `"event"` or `"scheduled"`.
    </ResponseField>

    <ResponseField name="enabled" type="boolean">
      Whether the automation is currently active.
    </ResponseField>

    <ResponseField name="trigger" type="object">
      The trigger configuration as provided in the request.
    </ResponseField>

    <ResponseField name="actions" type="array">
      The ordered list of actions as provided in the request.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the automation was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of the most recent update.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Get an automation

**`GET`** **`https://api.chevre.io/v1/automations/{id}`**

Retrieves a single automation by its ID, including its full trigger and actions configuration.

### Path parameters

<ParamField path="id" type="string" required>
  The unique identifier of the automation to retrieve (e.g. `auto_01GHI`).
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.chevre.io/v1/automations/auto_01GHI" \
    --header "Authorization: Bearer <your_api_key>" \
    --header "Accept: application/json"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.chevre.io/v1/automations/auto_01GHI",
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.chevre.io/v1/automations/auto_01GHI",
    {
      headers: {
        Authorization: "Bearer <your_api_key>",
        Accept: "application/json",
      },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### Example response

```json 200 theme={null}
{
  "data": {
    "id": "auto_01GHI",
    "project_id": "proj_01ABC",
    "name": "New Task Alert",
    "type": "event",
    "enabled": true,
    "trigger": {
      "event": "task.created",
      "filters": []
    },
    "actions": [
      {
        "type": "send_slack_message",
        "config": {
          "channel": "#general",
          "message": "New task created: {{task.name}}"
        }
      }
    ],
    "created_at": "2024-03-10T12:00:00Z",
    "updated_at": "2024-05-01T09:45:00Z"
  }
}
```

### Response fields

<ResponseField name="data" type="object">
  The requested automation object with full configuration.

  <Expandable title="automation object">
    <ResponseField name="id" type="string">
      The unique identifier for the automation.
    </ResponseField>

    <ResponseField name="project_id" type="string">
      The ID of the project this automation belongs to.
    </ResponseField>

    <ResponseField name="name" type="string">
      The display name of the automation.
    </ResponseField>

    <ResponseField name="type" type="string">
      The automation type: `"event"` or `"scheduled"`.
    </ResponseField>

    <ResponseField name="enabled" type="boolean">
      Whether the automation is currently active.
    </ResponseField>

    <ResponseField name="trigger" type="object">
      The trigger configuration object.
    </ResponseField>

    <ResponseField name="actions" type="array">
      The ordered list of action objects.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the automation was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of the most recent update.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Update an automation

**`PATCH`** **`https://api.chevre.io/v1/automations/{id}`**

Updates one or more fields on an existing automation. Send only the fields you want to change. To pause an automation without deleting it, set `enabled` to `false`.

### Path parameters

<ParamField path="id" type="string" required>
  The unique identifier of the automation to update (e.g. `auto_01GHI`).
</ParamField>

### Request body

<ParamField body="name" type="string">
  A new display name for the automation.
</ParamField>

<ParamField body="enabled" type="boolean">
  Set to `false` to pause the automation, or `true` to re-enable it.
</ParamField>

<ParamField body="trigger" type="object">
  A replacement trigger configuration. The entire `trigger` object is replaced — partial updates to trigger subfields are not supported.
</ParamField>

<ParamField body="actions" type="array">
  A replacement list of actions. The entire `actions` array is replaced — partial updates to individual actions are not supported.
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request PATCH \
    --url "https://api.chevre.io/v1/automations/auto_01GHI" \
    --header "Authorization: Bearer <your_api_key>" \
    --header "Content-Type: application/json" \
    --data '{
      "name": "New Task Slack Alert",
      "enabled": false
    }'
  ```

  ```python Python theme={null}
  import requests

  response = requests.patch(
      "https://api.chevre.io/v1/automations/auto_01GHI",
      json={"name": "New Task Slack Alert", "enabled": False},
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.chevre.io/v1/automations/auto_01GHI",
    {
      method: "PATCH",
      headers: {
        Authorization: "Bearer <your_api_key>",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ name: "New Task Slack Alert", enabled: false }),
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### Example response

```json 200 theme={null}
{
  "data": {
    "id": "auto_01GHI",
    "project_id": "proj_01ABC",
    "name": "New Task Slack Alert",
    "type": "event",
    "enabled": false,
    "trigger": {
      "event": "task.created",
      "filters": []
    },
    "actions": [
      {
        "type": "send_slack_message",
        "config": {
          "channel": "#general",
          "message": "New task created: {{task.name}}"
        }
      }
    ],
    "created_at": "2024-03-10T12:00:00Z",
    "updated_at": "2024-06-10T10:00:00Z"
  }
}
```

### Response fields

<ResponseField name="data" type="object">
  The updated automation object, reflecting all applied changes.

  <Expandable title="automation object">
    <ResponseField name="id" type="string">
      The unique identifier for the automation.
    </ResponseField>

    <ResponseField name="project_id" type="string">
      The ID of the project this automation belongs to.
    </ResponseField>

    <ResponseField name="name" type="string">
      The updated or unchanged display name.
    </ResponseField>

    <ResponseField name="type" type="string">
      The automation type: `"event"` or `"scheduled"`. Cannot be changed after creation.
    </ResponseField>

    <ResponseField name="enabled" type="boolean">
      The updated enabled state of the automation.
    </ResponseField>

    <ResponseField name="trigger" type="object">
      The updated or unchanged trigger configuration.
    </ResponseField>

    <ResponseField name="actions" type="array">
      The updated or unchanged list of actions.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the automation was originally created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of this update.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Delete an automation

**`DELETE`** **`https://api.chevre.io/v1/automations/{id}`**

Permanently deletes an automation and all of its run history. Disable the automation first if you want to stop it from running without losing its configuration and history.

<Warning>
  This action is **permanent and irreversible**. The automation's run history will also be deleted. If you only want to stop the automation from running, set `enabled` to `false` using the [Update an automation](#update-an-automation) endpoint instead.
</Warning>

### Path parameters

<ParamField path="id" type="string" required>
  The unique identifier of the automation to delete (e.g. `auto_01GHI`).
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request DELETE \
    --url "https://api.chevre.io/v1/automations/auto_01GHI" \
    --header "Authorization: Bearer <your_api_key>"
  ```

  ```python Python theme={null}
  import requests

  response = requests.delete(
      "https://api.chevre.io/v1/automations/auto_01GHI",
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.status_code)  # 204
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.chevre.io/v1/automations/auto_01GHI",
    {
      method: "DELETE",
      headers: {
        Authorization: "Bearer <your_api_key>",
      },
    }
  );
  console.log(response.status); // 204
  ```
</CodeGroup>

### Example response

```json 204 theme={null}
// No content returned on successful deletion
```

<Note>
  A successful deletion returns HTTP `204 No Content` with an empty response body.
</Note>

***

## List automation runs

**`GET`** **`https://api.chevre.io/v1/automations/{id}/runs`**

Returns the run history for a specific automation, ordered by start time with the most recent run first. Use this endpoint to debug automation failures or audit execution history.

### Path parameters

<ParamField path="id" type="string" required>
  The unique identifier of the automation whose run history you want to retrieve (e.g. `auto_01GHI`).
</ParamField>

### Query parameters

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="per_page" type="integer" default="20">
  The number of runs to return per page. Maximum is `100`.
</ParamField>

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.chevre.io/v1/automations/auto_01GHI/runs?page=1&per_page=20" \
    --header "Authorization: Bearer <your_api_key>" \
    --header "Accept: application/json"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.chevre.io/v1/automations/auto_01GHI/runs",
      params={"page": 1, "per_page": 20},
      headers={"Authorization": "Bearer <your_api_key>"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.chevre.io/v1/automations/auto_01GHI/runs?page=1&per_page=20",
    {
      headers: {
        Authorization: "Bearer <your_api_key>",
        Accept: "application/json",
      },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### Example response

```json 200 theme={null}
{
  "data": [
    {
      "id": "run_01MNO",
      "automation_id": "auto_01GHI",
      "status": "success",
      "started_at": "2024-06-10T09:00:05Z",
      "completed_at": "2024-06-10T09:00:06Z",
      "error_message": null
    },
    {
      "id": "run_02PQR",
      "automation_id": "auto_01GHI",
      "status": "failed",
      "started_at": "2024-06-09T09:00:04Z",
      "completed_at": "2024-06-09T09:00:04Z",
      "error_message": "Slack channel #general not found."
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 20
  }
}
```

### Response fields

<ResponseField name="data" type="array">
  An array of run objects for the automation.

  <Expandable title="run object">
    <ResponseField name="id" type="string">
      The unique identifier for this run, prefixed with `run_`.
    </ResponseField>

    <ResponseField name="automation_id" type="string">
      The ID of the automation that produced this run.
    </ResponseField>

    <ResponseField name="status" type="string">
      The result of the run. One of:

      * `"success"` — all actions executed without errors.
      * `"failed"` — one or more actions encountered an error.
      * `"pending"` — the run is currently in progress.
    </ResponseField>

    <ResponseField name="started_at" type="string">
      ISO 8601 timestamp of when the run began.
    </ResponseField>

    <ResponseField name="completed_at" type="string">
      ISO 8601 timestamp of when the run finished. `null` if the run is still pending.
    </ResponseField>

    <ResponseField name="error_message" type="string">
      A human-readable description of the error, if the run failed. `null` for successful or pending runs.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="meta" type="object">
  Pagination metadata.

  <Expandable title="meta object">
    <ResponseField name="total" type="integer">
      Total number of runs in the automation's history.
    </ResponseField>

    <ResponseField name="page" type="integer">
      The current page number returned.
    </ResponseField>

    <ResponseField name="per_page" type="integer">
      The number of results per page used for this response.
    </ResponseField>
  </Expandable>
</ResponseField>