> ## Documentation Index > Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt > Use this file to discover all available pages before exploring further. # List triggers > Returns all triggers for the org, optionally filtered by campaign. List triggers — returns {types, schemas, results} **Permission:** Requires `automations` **or** `campaigns`; sending `type: "lesson"` additionally requires `lessons`. Denials read `Manage Automations or Campaigns`. **Response shape:** `data` is a composite object — `results` alongside `schemas`, `types` and related keys. This is **not** a paginated envelope; `page` has no effect and there is no `count`. **How a trigger relates to a campaign.** `campaign_id` in the body decides scoping and is **optional**: - **Omit it** and the trigger is scoped to your team directly — this is the automation case. - **Pass a default (simple) campaign** and it is likewise scoped to the team. - **Pass a regular campaign** and the trigger is scoped to the org and user instead, with no `team_id` stored on it. That is deliberate — storing a team on a trigger inside a shared campaign would produce a campaign only some members can see. If the campaign id cannot be resolved within your team scope, the request is narrowed rather than rejected, so a wrong id yields an empty or unexpected scope instead of an error. ## OpenAPI ````yaml /api-reference/specs/triggers.json get /api/triggers openapi: 3.1.0 info: title: ConveYour API — Triggers description: Retrieve, create, validate, and update campaign triggers. version: 1.0.0 servers: - url: https://{subdomain}.conveyour.com description: Your organization's ConveYour instance variables: subdomain: default: acme description: >- Your organization's slug — the subdomain you sign in on. Replace `acme` with yours: if you sign in at `bigco.conveyour.com`, enter `bigco`. security: - conveyourToken: [] tags: - name: Triggers description: Retrieve, create, validate, and update campaign triggers. paths: /api/triggers: get: tags: - Triggers summary: List triggers description: >- Returns all triggers for the org, optionally filtered by campaign. List triggers — returns {types, schemas, results} **Permission:** Requires `automations` **or** `campaigns`; sending `type: "lesson"` additionally requires `lessons`. Denials read `Manage Automations or Campaigns`. **Response shape:** `data` is a composite object — `results` alongside `schemas`, `types` and related keys. This is **not** a paginated envelope; `page` has no effect and there is no `count`. **How a trigger relates to a campaign.** `campaign_id` in the body decides scoping and is **optional**: - **Omit it** and the trigger is scoped to your team directly — this is the automation case. - **Pass a default (simple) campaign** and it is likewise scoped to the team. - **Pass a regular campaign** and the trigger is scoped to the org and user instead, with no `team_id` stored on it. That is deliberate — storing a team on a trigger inside a shared campaign would produce a campaign only some members can see. If the campaign id cannot be resolved within your team scope, the request is narrowed rather than rejected, so a wrong id yields an empty or unexpected scope instead of an error. operationId: listTriggersReturnsTypesSchemasResults parameters: - name: campaign in: query description: Filter triggers by campaign ID. schema: type: string - name: bookmark_id in: query description: Filter triggers by bookmark (group) ID. schema: type: string - $ref: '#/components/parameters/teams' responses: '200': description: Success. content: application/json: schema: allOf: - $ref: '#/components/schemas/Envelope' - type: object properties: data: $ref: '#/components/schemas/TriggerIndex' example: status: ok message: success data: types: lesson: group: content name: Send Lesson doc: '' schemas: lesson: lesson_id: type: string label: Lesson delay: type: integer label: Delay (seconds) results: - id: 64a1b2c3d4e5f6a7b8c9d0e1 campaign_id: 64a1b2c3d4e5f6a7b8c9d0e2 type: lesson lesson_id: 64a1b2c3d4e5f6a7b8c9d0e3 delay: 0 '403': $ref: '#/components/responses/Forbidden' components: parameters: teams: name: teams[] in: query description: >- Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so `teams=A&teams=B` silently resolves to B alone. On requests with a JSON body you may send `teams` (no brackets) in the body instead. **Values that are not valid ObjectIds are silently ignored** — a mistyped team ID behaves as if no team was sent. See the [teams section of the API conventions guide](/guides/api-conventions#team-scoping). style: form explode: true schema: type: array items: type: string example: - 64a1b2c3d4e5f6a7b8c9d0ff schemas: Envelope: type: object description: The common response envelope shared by all ConveYour endpoints. properties: status: type: string enum: - ok - failed description: '`ok` on success, `failed` on error.' message: type: string description: Human-readable description of the result. data: description: >- The response payload — an object or an array depending on the endpoint. TriggerIndex: type: object description: >- The trigger list endpoint returns a composite object, not a bare array: the matching triggers plus the type catalogue and per-type field schemas used to build the editor. properties: results: type: array items: $ref: '#/components/schemas/Trigger' description: Matching triggers, with vanity names resolved. types: type: object description: >- Creatable trigger types, keyed by type id. Types the user may not create are omitted. additionalProperties: type: object properties: group: type: string description: Type group. name: type: string description: Human-readable type name. doc: type: string description: Documentation slug. schemas: type: object description: >- Field schema per trigger type, keyed by type id. When bookmark_id is passed, fields marked simple=false or hidden are filtered out. additionalProperties: type: object required: - results - types - schemas Trigger: type: object description: >- An automation trigger. Each trigger type carries additional type-specific keys beyond the base fields listed here. properties: id: type: string description: Trigger ID. org_id: type: integer description: Owning organization. name: type: string description: Trigger name. notes: type: string description: Internal notes. type: type: string description: Trigger type, which determines the extra fields present. delay: type: number description: Delay before the trigger fires. start_date: type: string description: Start date. start_at: type: string description: Start time. tz_relative: type: boolean description: Whether timing is relative to the contact's timezone. automatic: type: boolean description: Whether the trigger runs automatically. end_days: type: number description: Days until the trigger stops. join_delay: type: boolean description: Whether to delay on join. order: type: number description: Sort order. bookmark: type: object description: Bookmark defining the audience. bookmark_id: type: string description: Audience bookmark ID. wf_pid: type: string description: Workflow public ID. wf_if: type: string description: Workflow condition. wf_detached: type: boolean description: Whether the workflow step is detached. created_at: type: integer description: Unix timestamp. updated_at: type: integer description: Unix timestamp. required: - name additionalProperties: description: >- Type-specific fields declared by the trigger type (`sms`, `email`, `lesson` and so on). responses: Forbidden: description: >- The token is missing or invalid, or the service account behind it lacks the permission this endpoint requires. content: application/json: example: status: failed message: Lacking necessary permission add_contacts data: permission: add_contacts securitySchemes: conveyourToken: type: apiKey in: header name: x-conveyour-token description: >- Your API key token. Contacts endpoints require a **Server-only — Full API** key — see [Authentication](/quickstart). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.