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

# List contacts

> **Permission:** `crm.contacts:read`

List this clinic's CRM contacts.



## OpenAPI

````yaml /openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/crm/contacts
openapi: 3.1.0
info:
  title: ClinikEHR API
  version: 1.0.0
  description: >-
    Server-to-server REST API for a clinic's own data, reached with a key the
    clinic (or a developer workspace) creates in the developer portal.


    Authenticate every request with `Authorization: Bearer <key>`. Test keys
    reach only your workspace's own synthetic sandbox; live keys reach the
    clinic that created them. Lists wrap their rows as `{ data, has_more,
    next_cursor }`; single resources are returned directly. Errors are
    `application/problem+json` (RFC 9457) with a stable `code`.


    Write requests accept an `Idempotency-Key` header so a retry never repeats a
    change. See the guides for authentication, permissions, pagination, rate
    limits and retries.
servers:
  - url: https://api.clinikehr.com
security:
  - ApiKey: []
paths:
  /v1/clinics/{clinic_id}/crm/contacts:
    get:
      tags:
        - CRM
      summary: List contacts
      description: |-
        **Permission:** `crm.contacts:read`

        List this clinic's CRM contacts.
      operationId: listCrmContacts
      parameters:
        - name: clinic_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: stage_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: updated_since
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: starting_after
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - has_more
                  - next_cursor
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CrmContact'
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - ApiKey: []
components:
  schemas:
    CrmContact:
      type: object
      description: >-
        Withheld, by NAME: clinic_id (implicit in the path), unsubscribe_token,
        migrated_from_patient_id, custom_color, created_by, confirmed_opt_in_at,
        marketing_authorization_id.
      required:
        - id
      properties:
        id:
          type: string
          format: uuid
        owner_staff_id:
          type:
            - string
            - 'null'
          format: uuid
        record_type:
          type:
            - string
            - 'null'
          enum:
            - lead
            - prospect
            - waitlist
            - referral
            - contact
            - null
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        company:
          type:
            - string
            - 'null'
        lifecycle_stage:
          type:
            - string
            - 'null'
          enum:
            - lead
            - inquiry
            - prospect
            - waitlist
            - customer
            - lost
            - null
        pipeline_id:
          type:
            - string
            - 'null'
          format: uuid
        stage_id:
          type:
            - string
            - 'null'
          format: uuid
        status:
          type:
            - string
            - 'null'
        source:
          type:
            - string
            - 'null'
        referral_source_id:
          type:
            - string
            - 'null'
          format: uuid
        referred_by_contact_id:
          type:
            - string
            - 'null'
          format: uuid
        interest:
          type:
            - string
            - 'null'
        desired_service_id:
          type:
            - string
            - 'null'
          format: uuid
        desired_provider_id:
          type:
            - string
            - 'null'
          format: uuid
        estimated_value_cents:
          type:
            - integer
            - 'null'
        currency:
          type:
            - string
            - 'null'
        priority:
          type:
            - string
            - 'null'
          enum:
            - low
            - normal
            - high
            - null
        score:
          type:
            - integer
            - 'null'
        marketing_opt_in:
          type:
            - boolean
            - 'null'
        sms_opt_in:
          type:
            - boolean
            - 'null'
        consent_at:
          type:
            - string
            - 'null'
          format: date-time
        consent_source:
          type:
            - string
            - 'null'
        do_not_contact:
          type:
            - boolean
            - 'null'
        unsubscribed_at:
          type:
            - string
            - 'null'
          format: date-time
        tags:
          type: array
          items:
            type: string
        custom_fields:
          type: object
        converted_patient_id:
          type:
            - string
            - 'null'
          format: uuid
        converted_at:
          type:
            - string
            - 'null'
          format: date-time
        lost_reason:
          type:
            - string
            - 'null'
        last_activity_at:
          type:
            - string
            - 'null'
          format: date-time
        next_task_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    Problem:
      type: object
      description: RFC 9457 application/problem+json.
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - pointer
              - message
            properties:
              pointer:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: >-
        The request failed validation (unknown query parameter, limit out of
        range, malformed body).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: >-
        Missing, malformed, unknown, revoked or expired key, or the wrong
        secret.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >-
        The key or connection lacks the required scope, the plan does not
        include this resource, the request came from an address this key's IP
        allow-list does not permit, a TEST-environment workspace key asked for a
        clinic_id other than its own workspace's sandbox (`sandbox_only`), or a
        LIVE workspace key asked for a real clinic while its workspace's
        verification has lapsed (`not_verified`) — the response never names
        which addresses ARE allowed, nor which clinic actually is the sandbox.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      description: Rate limited. See the Retry-After header.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: ehr_live_<keyId>_<secret> or ehr_test_<keyId>_<secret>

````

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