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

> Returns a paginated feed of contact activity events for the org, sorted by timestamp (newest first). Non-admin keys are automatically scoped to the contacts the user manages.

List a paginated feed of contact activity events

**Response shape:** `data` is an object with `count`, `page`, `pages` and `results`. It does **not** return `per_page`, `has_more` or `has_less`.

**This is the contact activity feed**, not a scheduling API. The route is named `/api/schedule` for historical reasons — it returns the event feed you see on the right-hand side of a contact's profile.



## OpenAPI

````yaml /api-reference/specs/schedule.json get /api/schedule
openapi: 3.1.0
info:
  title: ConveYour API — Schedule
  description: >-
    Read a paginated feed of contact activity events and export rep-stats
    history as CSV.
  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: Schedule
    description: >-
      Read a paginated feed of contact activity events and export rep-stats
      history as CSV.
paths:
  /api/schedule:
    get:
      tags:
        - Schedule
      summary: List activity
      description: >-
        Returns a paginated feed of contact activity events for the org, sorted
        by timestamp (newest first). Non-admin keys are automatically scoped to
        the contacts the user manages.


        List a paginated feed of contact activity events


        **Response shape:** `data` is an object with `count`, `page`, `pages`
        and `results`. It does **not** return `per_page`, `has_more` or
        `has_less`.


        **This is the contact activity feed**, not a scheduling API. The route
        is named `/api/schedule` for historical reasons — it returns the event
        feed you see on the right-hand side of a contact's profile.
      operationId: listAPaginatedFeedOfContactActivityEvents
      parameters:
        - name: contact
          in: query
          description: >-
            Restrict the feed to a single contact (contact id or pid). When set,
            results are not additionally filtered by the search/bookmark contact
            scope.
          schema:
            type: string
        - name: trigger
          in: query
          description: Filter to events produced by a specific trigger id.
          schema:
            type: string
        - name: date
          in: query
          description: >-
            Restrict results to the day range containing this date. Parsed in
            the org's rep-bucket timezone (e.g. `2026-07-29`).
          schema:
            type: string
        - name: sort
          in: query
          description: Sort option passed through to the feed query.
          schema:
            type: string
        - name: fields
          in: query
          description: >-
            Comma-separated list (or array) of fields to project. `name` and
            `data` are always included.
          schema:
            type: string
        - name: search
          in: query
          description: >-
            Contact search string used to scope which contacts' events are
            returned. `filters` is accepted as an alias.
          schema:
            type: string
        - name: fuzzy_search
          in: query
          description: Fuzzy-match across related campaign, trigger, and lesson names.
          schema:
            type: string
        - name: bookmark
          in: query
          description: Apply a saved bookmark's contact filter to scope the feed.
          schema:
            type: string
        - name: teams
          in: query
          description: >-
            Team id (or array of team ids — the first is used) to scope contacts
            by team.
          schema:
            type: string
        - name: public_key
          in: query
          description: >-
            Base64-encoded public key used to re-encrypt decrypted secret values
            when the org requires a public encryption key.
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
        - name: expected_value
          in: query
          required: false
          description: >-
            CSV export only. What the encrypted column should contain. Defaults
            to `encrypted`.
          schema:
            type: string
        - name: page
          in: query
          description: Page number.
          required: false
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: Records per page. Defaults to the limits.schedule config value.
          required: false
          schema:
            type: integer
        - name: filters
          in: query
          required: false
          schema:
            type: string
          description: >-
            **Search fallback, not a filter object.** `search` takes precedence;
            `filters` is only consulted when `search` is absent. The value is
            used as a search string, so it does not behave like the `filters`
            object on other endpoints.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              example:
                status: ok
                message: success
                data:
                  page: 1
                  pages: 8
                  count: 372
                  results:
                    - event: answered_question
                      campaign: 64a1b2c3d4e5f6a7b8c9d0e1
                      trigger: 64a1b2c3d4e5f6a7b8c9d0e2
                      answer: 'Yes'
                      points: 5
                      vanity:
                        campaign: Onboarding
                        trigger: Interest Check
                        lesson: ''
                      reviews: []
                      comments: []
                      $id: 64a1b2c3d4e5f6a7b8c9d0e3
                      $timestamp: 1753800000
                      $date: '2026-07-29 10:00:00'
                      $cid: 64a1b2c3d4e5f6a7b8c9d0e4
                      $name: Jane Doe
                      $photo: https://cdn.conveyour.com/photo.jpg
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          results:
                            type: array
                            items:
                              type: object
                              description: >-
                                Endpoint-specific payload; shape not verified
                                against a live response.
                          page:
                            type: integer
                          pages:
                            type: integer
                          count:
                            type: integer
                        description: >-
                          Paginated schedule entries. Returns `page`, `pages`,
                          `count` and `results`; `pages` is `ceil(count /
                          limit)`.
        '403':
          $ref: '#/components/responses/ForbiddenToken'
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.
  responses:
    ForbiddenToken:
      description: >-
        The token is missing, expired, or not permitted for this HTTP method.
        **This endpoint enforces no named permission**, so a 403 here never
        carries a `permission` field.
      content:
        application/json:
          example:
            status: failed
            message: Token is either expired or does not have the correct permissions
            data: []
  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.