> ## 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.

# List API requests

> Your API calls of the last 30 days, newest first: the address, the status, the error (code, field and reason), how long it took, the key, To, Reference, the Idempotency-Key and the message or campaign the call made. Never a request or reply body here (GET /v1/requests/{id}), never an API key or a secret. Calls to /v1/requests are listed too.

Permission: A Full key.



## OpenAPI

````yaml /openapi.json get /v1/requests
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: Inbox
  - name: Campaigns
  - name: Webhooks
  - name: Request log
paths:
  /v1/requests:
    get:
      tags:
        - Request log
      summary: List API requests
      description: >-
        Your API calls of the last 30 days, newest first: the address, the
        status, the error (code, field and reason), how long it took, the key,
        To, Reference, the Idempotency-Key and the message or campaign the call
        made. Never a request or reply body here (GET /v1/requests/{id}), never
        an API key or a secret. Calls to /v1/requests are listed too.


        Permission: A Full key.
      parameters:
        - name: since
          in: query
          required: false
          description: From this time (ISO 8601). At most 30 days back.
          schema:
            type: string
            format: date-time
        - name: until
          in: query
          required: false
          description: Up to this time (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: status
          in: query
          required: false
          description: succeeded (status below 400) or failed.
          schema:
            type: string
            enum:
              - succeeded
              - failed
        - name: path
          in: query
          required: false
          description: >-
            One address, as called (/v1/messages/template) or as its route
            (/v1/contacts/{phone}).
          schema:
            type: string
        - name: key
          in: query
          required: false
          description: One API key's id.
          schema:
            type: string
        - name: to
          in: query
          required: false
          description: >-
            The customer of a message send: a number with its country code, e.g.
            +9198250*****, or a WhatsApp username id.
          schema:
            type: string
        - name: reference
          in: query
          required: false
          description: Your reference, exactly.
          schema:
            type: string
        - name: per_page
          in: query
          required: false
          description: How many on a page (at most 100).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: cursor
          in: query
          required: false
          description: next_cursor from the page before. Leave out for the first page.
          schema:
            type: string
      responses:
        '200':
          description: A page of calls.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RequestLine'
                  per_page:
                    type: integer
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Send it back as ?cursor= for the next page; null on the
                      last page.
                required:
                  - data
                  - next_cursor
              example:
                data:
                  - id: string
                    time: '2026-10-26T11:20:00+05:30'
                    method: POST
                    path: /v1/messages/template
                    status: 201
                    succeeded: true
                    error:
                      code: string
                      field: string
                      reason: string
                    took_ms: 1
                    ip: string
                    key:
                      id: string
                      name: string
                    key_deleted: true
                    to: string
                    reference: string
                    idempotency_key: string
                    message_id: string
                    campaign_id: string
                per_page: 1
                next_cursor: string
        '400':
          description: 'validation_error: Some fields are missing or wrong.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validation_error:
                  value:
                    error:
                      code: validation_error
                      message: Some fields are missing or wrong.
        '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.
        '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:
    RequestLine:
      type: object
      properties:
        id:
          type: string
        time:
          type: string
          format: date-time
          description: When the call came in (India time).
        method:
          type: string
          example: POST
        path:
          type: string
          example: /v1/messages/template
        status:
          type: integer
          example: 201
        succeeded:
          type: boolean
          description: true when the status is below 400.
        error:
          type:
            - object
            - 'null'
          description: null when the call succeeded.
          properties:
            code:
              type: string
            field:
              type:
                - string
                - 'null'
            reason:
              type:
                - string
                - 'null'
              description: The message we answered.
        took_ms:
          type: integer
        ip:
          type:
            - string
            - 'null'
        key:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            name:
              type:
                - string
                - 'null'
        key_deleted:
          type: boolean
          description: >-
            true when the call's key has since been deleted (its calls stay in
            the log).
        to:
          type:
            - string
            - 'null'
          description: A message send's customer; null for every other call.
        reference:
          type:
            - string
            - 'null'
        idempotency_key:
          type:
            - string
            - 'null'
        message_id:
          type:
            - string
            - 'null'
          description: The message the call made.
        campaign_id:
          type:
            - string
            - 'null'
          description: The campaign the call made.
    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.