> ## 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 address books



## OpenAPI

````yaml /openapi/contact.json get /address-books
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:
  /address-books:
    get:
      summary: List address books
      operationId: listAddressBooks
      parameters:
        - name: page
          in: query
          schema:
            description: 'Page number for pagination (default: 1).'
            type: integer
            minimum: 1
          required: false
        - name: limit
          in: query
          schema:
            description: 'Number of items per page (default: 10).'
            type: integer
            minimum: 1
          required: false
        - name: q
          in: query
          schema:
            description: >-
              Search query to filter address books by name (case-insensitive,
              partial match).
            type: string
          required: false
        - name: parent_ven_id
          in: query
          schema:
            description: Filter by parent vendor ID (reseller accounts).
            type: string
          required: false
        - name: start_date
          in: query
          schema:
            description: Filter address books created on or after this date.
            type: string
          required: false
        - name: end_date
          in: query
          schema:
            description: Filter address books created on or before this date.
            type: string
          required: false
      responses:
        '200':
          description: List of address books with pagination metadata.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        addressbook:
                          description: Address book name.
                          type: string
                        id:
                          description: Unique address book ID.
                          type: string
                        description:
                          description: Address book description.
                          type: string
                        created:
                          description: Creation timestamp (ISO 8601).
                        contacts_count:
                          description: Number of contacts in this address book.
                          type: integer
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      totalItems:
                        description: Total matching address books.
                        type: integer
                      currentPage:
                        description: Current page number.
                        type: integer
                      pageSize:
                        description: Items per page.
                        type: integer
                      totalPages:
                        description: Total pages available.
                        type: integer
                      startPage:
                        description: First page in range.
                        type: integer
                      endPage:
                        description: Last page in range.
                        type: integer
                      startIndex:
                        description: Start index on this page.
                        type: integer
                      endIndex:
                        description: End index on this page.
                        type: integer
                      pages:
                        description: Available page numbers.
                        type: array
                        items:
                          type: integer
                    additionalProperties: false
                additionalProperties: false
              examples:
                addressBookList:
                  summary: Address books retrieved
                  value:
                    data:
                      - addressbook: Default
                        contacts_count: 30
                        description: ''
                        created: '2021-03-10T19:10:47.708Z'
                        id: 604919718fb019194453764e
                      - description: Test Group
                        addressbook: Trial
                        contacts_count: 0
                        created: '2021-07-08T14:28:54.155Z'
                        id: 60e70ba6ffe24b0019011782
                    pagination:
                      totalItems: 2
                      currentPage: 1
                      pageSize: 10
                      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.

````