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

# List WhatsApp phone numbers

> Lists the connected WhatsApp phone number with Meta profile fields stored by GreenTick. Filter with ref or id query params to narrow to one line.



## OpenAPI

````yaml /openapi.json get /phone-numbers
openapi: 3.1.0
info:
  title: GreenTick Developer API
  version: 1.0.0
  summary: WhatsApp messaging, contacts, workflows, and webhooks
  description: >-
    Use GreenTick's REST API to send WhatsApp messages, synchronize contacts,
    trigger workflows, and receive signed event webhooks. Each API key belongs
    to one connected phone number.
  contact:
    name: GreenTick Support
    url: https://greentick.ai
servers:
  - url: https://api.greentick.ai/v1
    description: GreenTick API v1
security: []
tags:
  - name: System
    description: Health and API metadata
  - name: Messages
    description: Send WhatsApp messages
  - name: Conversations
    description: List inbox threads and fetch message history
  - name: Templates
    description: Discover approved templates and their variables
  - name: Contacts
    description: Synchronize customer contacts
  - name: Labels
    description: Contact label catalog for the connected phone number
  - name: Attributes
    description: Contact custom attribute definitions for the connected phone number
  - name: Phone numbers
    description: WhatsApp sending line for this phone number
  - name: Automations
    description: List enrollable automations and start one for a contact
  - name: Workflow hooks
    description: Trigger GreenTick automations from external systems
  - name: Webhooks
    description: Subscribe Zapier, Make.com, or your own server to GreenTick events
  - name: API key
    description: Check the Bearer API key and account timezone
  - name: MCP platform
    description: Limits, usage, and shared connector behavior
  - name: Media
    description: Host customer-supplied files
  - name: Workflows
    description: Create, publish, and export automations
  - name: Flows
    description: WhatsApp Flows
  - name: AI bots
    description: AI bots and knowledge
  - name: Broadcasts
    description: Template broadcasts
  - name: Catalogs
    description: Commerce catalogs, products, and orders
  - name: Ads
    description: Click-to-WhatsApp ads and conversions
paths:
  /phone-numbers:
    get:
      tags:
        - Phone numbers
      summary: List WhatsApp phone numbers
      description: >-
        Lists the connected WhatsApp phone number with Meta profile fields
        stored by GreenTick. Filter with ref or id query params to narrow to one
        line.
      operationId: listPhoneNumbers
      parameters:
        - name: ref
          in: query
          schema:
            type: string
          description: >-
            GreenTick phone line id (ref field). Use as phoneNumberRef when
            sending.
        - name: id
          in: query
          schema:
            type: string
          description: Meta WhatsApp phone_number_id
      responses:
        '200':
          description: Phone numbers
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PhoneNumber'
                  total:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKey: []
components:
  schemas:
    PhoneNumber:
      type: object
      properties:
        ref:
          type: string
          description: >-
            GreenTick phone line ID — pass as phoneNumberRef when sending
            messages
        id:
          type: string
          description: Meta WhatsApp phone_number_id
        display_phone_number:
          type: string
          example: +1 555-123-4567
        verified_name:
          type: string
          example: GreenTick
        quality_rating:
          type: string
          enum:
            - GREEN
            - YELLOW
            - RED
            - UNKNOWN
            - ''
        throughput:
          type: object
          nullable: true
          properties:
            level:
              type: string
              description: Meta messaging throughput tier
        code_verification_status:
          type: string
          example: VERIFIED
        status:
          type: string
          description: Meta phone number connection status
          example: CONNECTED
        new_name_status:
          type: string
          example: NONE
        is_on_biz_app:
          type: boolean
        history_sync:
          type: object
          nullable: true
          properties:
            status:
              type: string
              enum:
                - pending
                - syncing
                - complete
                - declined
            progress:
              type: number
            phase:
              type: integer
              nullable: true
            updatedAt:
              type: string
              format: date-time
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API key
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - code
              - message
            properties:
              success:
                type: boolean
                example: false
              code:
                type: string
                example: INVALID_TO
              message:
                type: string
                example: to (E.164 phone) is required
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: gt_live_…
      description: >-
        Create an API key in GreenTick Developer settings. Send it as
        Authorization: Bearer gt_live_… (Bearer prefix required).

````

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