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

# List contact follow-ups

> Retrieves a paginated list of follow-ups scheduled for contacts. Requires `crm:read` scope.

Retrieves a paginated list of follow-up tasks scheduled for contacts.

### Query parameters

* `page` (integer, optional): The page number to retrieve. Defaults to `1`.
* `limit` (integer, optional): The number of records to return per page. Defaults to `20`. Maximum permitted limit is `200`.
* `search` (string, optional): A keyword matching title or notes.

### Required permissions

Requires an API key with the `crm:read` scope.


## OpenAPI

````yaml GET /contact-followups
openapi: 3.1.0
info:
  title: Automate CRM API
  description: >-
    External integration API for Automate CRM. Manage leads, contacts, products,
    follow-ups, custom fields, and real-time inbox lookups.
  version: 1.0.0
servers:
  - url: https://crm-api.automatebusiness.com/api/v1/integrations-public
    description: Production Integration Server
security:
  - apiKeyAuth: []
paths:
  /contact-followups:
    get:
      summary: List Contact Follow-ups
      description: >-
        Retrieves a paginated list of follow-ups scheduled for contacts.
        Requires `crm:read` scope.
      operationId: listContactFollowups
      parameters:
        - name: page
          in: query
          description: Page number to retrieve
          required: false
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: 'Number of records per page (default: 20, max: 200)'
          required: false
          schema:
            type: integer
            default: 20
            maximum: 200
        - name: search
          in: query
          description: Search keyword matching follow-up title or notes
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Contact follow-ups retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactFollowupListResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
      security:
        - apiKeyAuth:
            - crm:read
components:
  schemas:
    ContactFollowupListResponse:
      allOf:
        - $ref: '#/components/schemas/ReadSuccessEnvelope'
        - type: object
          properties:
            data:
              type: object
              properties:
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/Followup'
                pagination:
                  $ref: '#/components/schemas/PaginationMeta'
    ReadSuccessEnvelope:
      type: object
      description: Standard envelope returned by all GET (read) endpoints
      properties:
        status:
          type: string
          example: success
        code:
          type: integer
          example: 200
        message:
          type: string
          example: Integrations public retrieved successfully
        data:
          description: The returned entity, collection, or payload
        timestamp:
          type: string
          format: date-time
          example: '2026-10-26T10:00:00.000Z'
      required:
        - status
        - code
        - message
        - data
        - timestamp
    Followup:
      type: object
      properties:
        id:
          type: string
          example: fol_7721a9
        entity_id:
          type: string
          description: Target lead or contact ID
          example: lead_890ef12a
        entity_type:
          type: string
          enum:
            - lead
            - contact
          example: lead
        title:
          type: string
          example: Contract Review Call
        notes:
          type: string
          example: Review updated pricing terms with CFO
        due_date:
          type: string
          format: date-time
          example: '2026-10-30T15:00:00.000Z'
        reminder_at:
          type: string
          format: date-time
          example: '2026-10-30T14:45:00.000Z'
        status:
          type: string
          enum:
            - pending
            - completed
            - cancelled
          example: pending
        assigned_to:
          type: string
          example: user_sarah
        created_at:
          type: string
          format: date-time
          example: '2026-10-26T10:00:00.000Z'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          example: 42
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 20
        totalPages:
          type: integer
          example: 3
    ErrorEnvelope:
      type: object
      description: Standard error envelope returned when a request fails
      properties:
        success:
          type: boolean
          example: false
        data:
          type: 'null'
          example: null
        error:
          type: object
          properties:
            message:
              type: string
              example: Validation failed
            details:
              type: array
              items:
                type: object
                properties:
                  message:
                    type: string
                    example: Required
                  field:
                    type: string
                    example: email
                  code:
                    type: string
                    example: invalid_type
          required:
            - message
      required:
        - success
        - data
        - error
  responses:
    UnauthorizedError:
      description: Unauthorized (invalid or missing x-api-key)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: Invalid or missing API key.
    ForbiddenError:
      description: Forbidden (API key lacks required crm:read or crm:write scope)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            success: false
            data: null
            error:
              message: 'Forbidden: insufficient permissions for this operation.'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Workspace API key header. The key implicitly determines your workspace
        isolation. Scopes: `crm:read` for GET/HEAD/OPTIONS, `crm:write` for
        POST/PATCH/PUT/DELETE.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.