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

# List API requests

> The requests made with this store's API keys, newest first, without what was sent or answered. Requests are kept for 30 days. `meta.keptDays` says so.

Needs the `logs.read` permission (Read API Requests).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/api-requests
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/api-requests:
    get:
      tags:
        - API requests
      summary: List API requests
      description: >-
        The requests made with this store's API keys, newest first, without what
        was sent or answered. Requests are kept for 30 days. `meta.keptDays`
        says so.


        Needs the `logs.read` permission (Read API Requests).
      operationId: requests.list
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Which page of the list. The first is 1.
          schema:
            type: integer
            default: 1
        - name: perPage
          in: query
          required: false
          description: How many a page holds, up to 100.
          schema:
            type: integer
            default: 50
        - name: keyId
          in: query
          required: false
          description: Only requests made with this API key.
          schema:
            type: string
        - name: method
          in: query
          required: false
          description: Only requests of this method.
          schema:
            type: string
            enum:
              - GET
              - POST
              - PUT
              - PATCH
              - DELETE
        - name: status
          in: query
          required: false
          description: >-
            Only requests that worked (`ok`), that were refused or failed
            (`failed`), or with one status code (`404`).
          schema:
            type: string
            example: failed
        - name: search
          in: query
          required: false
          description: A request's ID, or part of a path.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        method:
                          type: string
                        path:
                          type: string
                        query:
                          type: string
                        operation:
                          type: string
                        status:
                          type: integer
                        code:
                          nullable: true
                        durationMs:
                          type: integer
                        ip:
                          type: string
                        userAgent:
                          type: string
                        apiKey:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            prefix:
                              type: string
                        createdAt:
                          type: string
                  pages:
                    type: integer
                  total:
                    type: integer
                  meta:
                    type: object
                    properties:
                      keptDays:
                        type: integer
                      perPageMax:
                        type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 7d763d2d-1b9b-4f60-a6fd-9ab8848c0e3d
                    method: GET
                    path: >-
                      /v1/stores/743d82fb-6aad-44bb-ab00-d54c4b0eecb7/webhook-deliveries
                    query: ''
                    operation: webhookDeliveries.list
                    status: 200
                    code: null
                    durationMs: 3
                    ip: 127.0.0.1
                    userAgent: ''
                    apiKey:
                      id: a253e656-a027-41b4-8302-786fd85cc6a6
                      name: Order sync
                      prefix: shoply_sk_3f9a1c
                    createdAt: '2026-10-22T16:20:20.433Z'
                  - id: 43e80891-dd10-4ca2-871f-d553d9bb2b5c
                    method: PUT
                    path: >-
                      /v1/stores/743d82fb-6aad-44bb-ab00-d54c4b0eecb7/webhooks/321460bf-ba98-4333-a6cd-f0e24de90f5e
                    query: ''
                    operation: webhooks.update
                    status: 200
                    code: null
                    durationMs: 5
                    ip: 127.0.0.1
                    userAgent: ''
                    apiKey:
                      id: a253e656-a027-41b4-8302-786fd85cc6a6
                      name: Order sync
                      prefix: shoply_sk_3f9a1c
                    createdAt: '2026-10-22T16:20:20.428Z'
                pages: 107
                total: 214
                meta:
                  keptDays: 30
                  perPageMax: 100
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const page = await shoply.requests.list();

            // Or every row of every page:
            for await (const row of shoply.requests.list()) {
              console.log(row);
            }
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $page = $shoply->requests->list();

            // Or every row of every page:
            foreach ($shoply->requests->list() as $row) {
                print_r($row);
            }
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            page = client.requests.list()

            # Or every row of every page:
            for row in client.requests.list():
                print(row)
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

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