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

# Your WhatsApp number

> Your WhatsApp number: display name, quality, daily messaging limit and whether it can send now.

Permission: Any key (Full, Send only or Read only).



## OpenAPI

````yaml /openapi.json get /v1/number
openapi: 3.1.0
info:
  title: GetReply API
  version: 1.0.0
  description: >-
    Send WhatsApp messages, templates, OTPs and campaigns from your own
    software. Every request needs an API key (Developer → API keys) as a Bearer
    token.


    Requests sent here are real and charged like any other.
servers:
  - url: https://api.getreply.in
    description: GetReply
security:
  - bearerAuth: []
tags:
  - name: Account
  - name: Messages
  - name: Templates
  - name: Contacts
  - name: Campaigns
  - name: Webhooks
paths:
  /v1/number:
    get:
      tags:
        - Account
      summary: Your WhatsApp number
      description: >-
        Your WhatsApp number: display name, quality, daily messaging limit and
        whether it can send now.


        Permission: Any key (Full, Send only or Read only).
      responses:
        '200':
          description: The number.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Number'
        '401':
          description: 'unauthorized: API key is missing or not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  value:
                    error:
                      code: unauthorized
                      message: API key is missing or not valid.
        '403':
          description: >-
            key_off: This API key is switched off. · forbidden_scope: This API
            key isn't allowed to do this. · ip_not_allowed: Requests from this
            IP address aren't allowed for this key. · needs_pro_plan: The API
            needs the Pro plan. · plan_ended: Your plan has ended. Renew it to
            send messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                key_off:
                  value:
                    error:
                      code: key_off
                      message: This API key is switched off.
                forbidden_scope:
                  value:
                    error:
                      code: forbidden_scope
                      message: This API key isn't allowed to do this.
                ip_not_allowed:
                  value:
                    error:
                      code: ip_not_allowed
                      message: >-
                        Requests from this IP address aren't allowed for this
                        key.
                needs_pro_plan:
                  value:
                    error:
                      code: needs_pro_plan
                      message: The API needs the Pro plan.
                plan_ended:
                  value:
                    error:
                      code: plan_ended
                      message: Your plan has ended. Renew it to send messages.
        '404':
          description: 'not_found: Not found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  value:
                    error:
                      code: not_found
                      message: Not found.
        '429':
          description: 'rate_limited: Too many requests. Try again in a few seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  value:
                    error:
                      code: rate_limited
                      message: Too many requests. Try again in a few seconds.
        '500':
          description: 'server_error: Something went wrong on our side. Try again.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server_error:
                  value:
                    error:
                      code: server_error
                      message: Something went wrong on our side. Try again.
components:
  schemas:
    Number:
      type: object
      properties:
        display_number:
          type: string
        display_name:
          type: string
        name_status:
          type:
            - string
            - 'null'
        quality:
          type: string
          enum:
            - green
            - yellow
            - red
            - unknown
        messaging_limit: {}
        status:
          type:
            - string
            - 'null'
        can_send:
          type: boolean
        restriction_reason:
          type:
            - string
            - 'null'
          description: >-
            WhatsApp's reason, exactly as WhatsApp sent it, while the number is
            restricted, flagged or banned, or a ban is scheduled; otherwise
            null. Several restrictions are separated by commas. The codes:
            RESTRICTED_BIZ_INITIATED_MESSAGING — the number can't start new
            chats; RESTRICTED_CUSTOMER_INITIATED_MESSAGING — the number can't
            reply to customers; RESTRICTED_ADD_PHONE_NUMBER_ACTION — no new
            numbers can be added to the account; a policy code such as ADULT —
            the account broke WhatsApp's policy of that kind; DISABLE — the
            account is disabled; SCHEDULE_FOR_DISABLE — the account will be
            disabled on the date in restriction_until. Any other code is passed
            on as WhatsApp sent it.
        restriction_until:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the restriction ends, or the day a scheduled disable starts
            (India time); null when WhatsApp gave no date.
        restricted_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When WhatsApp restricted, flagged or banned the number (India time);
            otherwise null.
        connected_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the number was connected to GetReply (India time).
        new_name:
          type:
            - string
            - 'null'
          description: A new display name you asked for; null when there is none.
        new_name_status:
          type:
            - string
            - 'null'
          enum:
            - approved
            - pending_review
            - declined
            - expired
            - null
          description: >-
            The new name's status: approved, pending_review, declined, or
            expired (approved but not used within 14 days); null when there is
            none.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: The one field that is wrong, when there is one.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. gr_live_…

````

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