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

# List contacts



## OpenAPI

````yaml /openapi/contact.json get /contacts
openapi: 3.0.3
info:
  title: Beem Contacts API
  version: 1.4.0
  description: >-
    The Beem Contacts API allows developers to manage address books and contacts
    for messaging workflows.
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://api-contact.beem.africa/public/v1
    description: Production server
  - url: https://dev-contact.beem.africa/public/v1
    description: Staging server
security: []
tags: []
paths:
  /contacts:
    get:
      summary: List contacts
      operationId: listContacts
      parameters:
        - name: addressbook_id
          in: query
          schema:
            description: Address book ID to list contacts from.
            type: string
          required: true
        - name: limit
          in: query
          schema:
            description: Maximum contacts to return per page.
            type: integer
          required: false
        - name: page
          in: query
          schema:
            description: Page number (starts at 1).
            type: integer
          required: false
        - name: q
          in: query
          schema:
            description: Search term to filter contacts by name or number.
            type: string
          required: false
        - name: tags
          in: query
          schema:
            description: Filter contacts by tag name.
            type: string
          required: false
      responses:
        '200':
          description: List of contacts with pagination metadata.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: Unique contact ID.
                          example: '1234567890'
                          type: string
                        mob_no:
                          description: Primary mobile number.
                          example: '254712345678'
                          anyOf:
                            - type: string
                            - type: number
                              format: float
                        mob_no2:
                          description: Secondary mobile number.
                        title:
                          description: Salutation or title.
                          nullable: true
                          example: Mr
                          type: string
                        first_name:
                          description: First name.
                          nullable: true
                          type: string
                        last_name:
                          description: Last name.
                          nullable: true
                          example: Doe
                          type: string
                        gender:
                          description: Gender.
                          nullable: true
                          example: Male
                          type: string
                        dob:
                          description: Date of birth.
                          example: '1990-01-01'
                        address_area:
                          description: Area or district.
                          nullable: true
                          example: Nairobi
                          type: string
                        address_city:
                          description: City.
                          nullable: true
                          example: Nairobi
                          type: string
                        address_country:
                          description: Country.
                          nullable: true
                          example: Kenya
                          type: string
                        email:
                          description: Email address.
                          nullable: true
                          example: john.doe@example.com
                          type: string
                        created:
                          description: Creation timestamp (ISO 8601).
                          example: '2021-01-01T00:00:00.000Z'
                      additionalProperties: false
                  pagination:
                    description: Pagination metadata.
                    type: object
                    properties: {}
                additionalProperties: false
              examples:
                contactList:
                  summary: Contacts retrieved
                  value:
                    data:
                      - id: 604919718fb0191944537663
                        mob_no: '255784021800'
                        mob_no2: ''
                        title: Mr.
                        first_name: Test
                        last_name: Test
                        gender: ''
                        dob: '1970-01-01T00:00:00.000Z'
                        address_area: ''
                        address_city: ''
                        address_country: ''
                        email: test@gmail.com
                        created: '2021-03-10T19:09:39.884Z'
                    pagination:
                      totalItems: 1
                      currentPage: 1
                      pageSize: 25
                      totalPages: 1
                      startPage: 1
                      endPage: 1
                      startIndex: 0
                      endIndex: 0
                      pages:
                        - 1
        '401':
          description: Unauthorized — invalid or missing API credentials.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: API error code.
                    example: 120
                  message:
                    type: string
                    description: Error message.
                    example: Invalid Authorization Parameters
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                invalidAuthorization:
                  summary: Invalid authorization
                  value:
                    code: 120
                    message: Invalid Authorization Parameters
        default:
          description: Unexpected error.
      security:
        - basicAuth: []
        - accessToken: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Beem API credentials: API key as username, API secret as password.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Access token only. Send as Authorization: <token> — do not use a Bearer
        prefix.

````