List Checkout Configurations

Retrieve all saved checkout widget configurations for your organization. ##

Request

curl --request GET \
  --url "$baseUrl/organization/checkout?page=1&limit=10&sortBy=createdAt&sortOrder=desc" \
  --header 'x-api-key: YOUR_API_KEY'
Query paramDefaultDescription
page1Page number
limit10Results per page
sortBycreatedAtField to sort by
sortOrderdescasc or desc

Response

{
  "success": true,
  "statusCode": 200,
  "message": "Configurations retrieved successfully",
  "data": {
    "items": [
      {
        "id": "chk_01hw3x7k2r4p5q6m8n9v",
        "brandColor": "#7C3AED",
        "environment": "live",
        "createdAt": "2024-07-01T10:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 20
  }
}

Use this to find the id of a configuration you want to reference elsewhere or pass to Archive Checkout Configuration.


Did this page help you?