> ## Documentation Index
> Fetch the complete documentation index at: https://onextel-09023014.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a contact list

> Read a list, its columns and a sample of contacts.



## OpenAPI

````yaml api-reference/truecaller/openapi.yaml GET /v1/lists/{id}
openapi: 3.1.0
info:
  title: OneXtel Truecaller Business Messaging API
  version: 1.0.0
  description: >
    Send verified business messages to Truecaller users: single messages,
    templates with

    personalisation, images, files and buttons, and campaigns to contact lists.


    Every request carries a workspace API key in the `x-api-key` header. Create
    one in the

    Truecaller campaigns portal under **Developers → API keys**.


    Errors are JSON with a single `error` string (and `details` for validation
    errors):


    ```json

    { "error": "invalid phone number" }

    ```
servers:
  - url: https://truecaller.udchowdhury.me
    description: Production
security:
  - apiKey: []
tags:
  - name: Messages
    description: Send one message and read its status.
  - name: Templates
    description: Reusable messages with variables, media and buttons.
  - name: Media
    description: Upload files to attach to templates.
  - name: Contact lists
    description: Audiences for campaigns.
  - name: Campaigns
    description: Send a template to a whole contact list, now or later.
  - name: Senders
    description: The verified business profiles your workspace sends from.
paths:
  /v1/lists/{id}:
    get:
      tags:
        - Contact lists
      summary: Get a contact list
      description: The list, its columns and up to 50 sample contacts.
      operationId: getList
      parameters:
        - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: The list.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ContactList'
                  - type: object
                    properties:
                      sample:
                        type: array
                        items:
                          type: object
                          properties:
                            phone:
                              type: string
                              example: '+919999999999'
                            attributes:
                              type: object
                              additionalProperties:
                                type: string
                              example:
                                name: Asha
                            opted_out:
                              type: boolean
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Id:
      in: path
      name: id
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    ContactList:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        columns:
          type: array
          items:
            type: string
          example:
            - name
            - city
        contact_count:
          type: integer
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: array
          items:
            type: object
  responses:
    NotFound:
      description: Not found in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not found
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Workspace API key from **Developers → API keys**. It starts with
        `tc_live_`.

````

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