> ## 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.

# Count contacts for a trigger

> Counts the contacts a trigger would apply to, within a campaign.

**`campaign` is required.** It is resolved through your team scope first; if it does not resolve, the request fails.

**Failure returns HTTP 200.** An unresolved campaign returns `200` with `status: "failed"` and the message `No campaign parameter passed to associate to this trigger`. Branch on `status`.

**Permission:** requires `campaigns`.



## OpenAPI

````yaml /api-reference/specs/triggers.json get /api/triggers/count
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/count:
    get:
      tags:
        - Triggers
      summary: Count contacts for a trigger
      description: >-
        Counts the contacts a trigger would apply to, within a campaign.


        **`campaign` is required.** It is resolved through your team scope
        first; if it does not resolve, the request fails.


        **Failure returns HTTP 200.** An unresolved campaign returns `200` with
        `status: "failed"` and the message `No campaign parameter passed to
        associate to this trigger`. Branch on `status`.


        **Permission:** requires `campaigns`.
      operationId: countTriggerContacts
      parameters:
        - name: campaign
          in: query
          required: true
          schema:
            type: string
          description: >-
            Campaign ID to count within. Required — resolved through your team
            scope.
        - name: filters
          in: query
          required: false
          style: deepObject
          explode: true
          schema:
            type: object
            additionalProperties:
              type: string
          description: >-
            Contact filter object, sent as bracketed keys (`filters[...]`).
            Passing a value that is present but falsy is treated as "no filter"
            — it does not error. Omit the parameter entirely to leave filtering
            untouched.
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        description: Matching contact count.
                        properties:
                          count:
                            type: integer
                            description: >-
                              Number of contacts matching the conditions. `0`
                              when the filter resolves to no queryable
                              conditions.
        '403':
          description: Forbidden — the key lacks the `campaigns` permission.
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.
  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.