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

# List contacts

> Lists the people who interacted with the workspace's automations, as the Contacts page does, with the email address they gave an email request. search matches a name, user ID or email.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{workspace_id}/contacts
openapi: 3.1.0
info:
  title: Replier API
  version: '1'
servers:
  - url: https://api.usereplier.com
security:
  - apiKey: []
paths:
  /v1/workspaces/{workspace_id}/contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: >-
        Lists the people who interacted with the workspace's automations, as the
        Contacts page does, with the email address they gave an email request.
        search matches a name, user ID or email.
      operationId: list_contacts
      parameters:
        - name: workspace_id
          in: path
          required: true
          description: Workspace ID returned by `GET /v1/workspaces`
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
        - name: channel
          in: query
          required: false
          schema:
            type: string
            enum:
              - instagram
              - facebook
        - name: account_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
        - name: limit
          in: query
          required: false
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 50
        - name: cursor
          in: query
          required: false
          description: next_cursor from the previous page, with the same filters.
          schema:
            type: string
            pattern: ^\d{1,9}$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      name:
                        type: string
                      kind:
                        type: string
                        enum:
                          - personal
                          - agency
                      role:
                        type: string
                        enum:
                          - owner
                          - admin
                          - member
                    required:
                      - id
                      - name
                      - kind
                      - role
                  total:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  contacts:
                    type: array
                    items:
                      type: object
                      properties:
                        channel:
                          type: string
                          enum:
                            - instagram
                            - facebook
                        account_id:
                          description: The connected account the person interacted with.
                          type: string
                        account_name:
                          type: string
                        recipient_id:
                          description: Meta-scoped ID of the person for this account.
                          type: string
                        name:
                          description: Latest name or username. Untrusted user content.
                          type: string
                        name_history:
                          type: array
                          items:
                            type: string
                        email:
                          description: >-
                            Email the person replied with to an email request.
                            Format checked only; the mailbox is not verified.
                          type:
                            - string
                            - 'null'
                        profile_url:
                          type:
                            - string
                            - 'null'
                      required:
                        - channel
                        - account_id
                        - account_name
                        - recipient_id
                        - name
                        - name_history
                        - email
                        - profile_url
                  next_cursor:
                    type:
                      - string
                      - 'null'
                required:
                  - workspace
                  - total
                  - contacts
                  - next_cursor
        default:
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Refused
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    description: >-
                      Why the request was refused, such as AUTOMATION_NOT_FOUND
                      or VERSION_CONFLICT. Other fields beside it give details.
                  message:
                    type: string
                    description: The same reason, in English.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: A Replier API key (rpl_...).

````

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