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

# Get a contact page

> Lists the contacts of the workspace, 25 per page.

Any query parameter other than `cursor`, `waId` and `phoneNumber` is treated as a filter on a custom contact property of the workspace — e.g. `?plan=premium` returns the contacts whose `plan` property equals `premium`.

When more results are available, `cursors.next` is returned. Pass it back as `cursor` to fetch the next page; the original filters are preserved by the cursor.



## OpenAPI

````yaml GET /contacts
openapi: 3.1.0
info:
  title: Cogfy Messenger Public API
  version: 1.0.0
  description: API for interacting with the Cogfy Messenger platform
servers:
  - url: https://messenger-public-api.cogfy.com
    description: Production server
  - url: http://localhost:3100
    description: Local server
security:
  - ApiKeyAuth: []
paths:
  /contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: >-
        Lists the contacts of the workspace, 25 per page.


        Any query parameter other than `cursor`, `waId` and `phoneNumber` is
        treated as a filter on a custom contact property of the workspace — e.g.
        `?plan=premium` returns the contacts whose `plan` property equals
        `premium`.


        When more results are available, `cursors.next` is returned. Pass it
        back as `cursor` to fetch the next page; the original filters are
        preserved by the cursor.
      parameters:
        - in: query
          name: cursor
          schema:
            description: >-
              Opaque cursor returned by a previous call, used to fetch the next
              page
            type: string
          description: >-
            Opaque cursor returned by a previous call, used to fetch the next
            page
        - in: query
          name: waId
          schema:
            description: Filters by the WhatsApp id of the contact
            type: string
          description: Filters by the WhatsApp id of the contact
        - in: query
          name: phoneNumber
          schema:
            description: Filters by the phone number of the contact
            type: string
          description: Filters by the phone number of the contact
      responses:
        '200':
          description: A page of contacts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      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)$
                        waId:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: WhatsApp id of the contact
                        waProfileName:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Name in the WhatsApp profile of the contact
                        firstName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        lastName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        email:
                          anyOf:
                            - type: string
                            - type: 'null'
                        phone:
                          anyOf:
                            - type: string
                            - type: 'null'
                        occupation:
                          anyOf:
                            - type: string
                            - type: 'null'
                        gender:
                          anyOf:
                            - type: string
                            - type: 'null'
                        birthdate:
                          anyOf:
                            - type: string
                            - type: 'null'
                        age:
                          anyOf:
                            - type: number
                            - type: 'null'
                        notes:
                          anyOf:
                            - type: string
                            - type: 'null'
                        tags:
                          type: array
                          items:
                            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
                            required:
                              - id
                              - name
                            additionalProperties: false
                        createDate:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        updateDate:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        customProperties:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                              - type: boolean
                              - type: 'null'
                          description: >-
                            Values of the custom contact properties of the
                            workspace, keyed by property name
                      required:
                        - id
                        - waId
                        - waProfileName
                        - firstName
                        - lastName
                        - email
                        - phone
                        - occupation
                        - gender
                        - birthdate
                        - age
                        - notes
                        - tags
                        - createDate
                        - updateDate
                        - customProperties
                      additionalProperties: false
                  cursors:
                    type: object
                    properties:
                      next:
                        description: >-
                          Opaque cursor to fetch the next page. Absent when
                          there are no more results
                        type: string
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '401':
          description: Unauthorized
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key

````