Checkout Page LogoCheckout Page
Support
Log inSign up

List all submissions

Returns a paginated list of form submissions owned by the authenticated seller, sorted newest-first. Supports filtering by customer, form page, status, and UTC creation timestamps.

GET/v1/submissions/

Authorization

api_key_auth
AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Query Parameters

search?string

Case-insensitive search matched against customerEmail, customerName, and formTitle (for example, 'jane' matches 'jane@example.com' and 'Jane Smith', while 'lead' matches 'Lead Capture Form').

pageId?string

Filter by the form page ID that received the submission.

Match^[0-9a-fA-F]{24}$
customerId?string

Filter by the associated customer ID.

Match^[0-9a-fA-F]{24}$
status?string

Filter by submission status.

Value in"succeeded" | "failed"
createdAfter?string

Filter by lower bound of createdAt. Use a UTC ISO 8601 timestamp with a Z suffix.

Formatdate-time
createdBefore?string

Filter by upper bound of createdAt. Use a UTC ISO 8601 timestamp with a Z suffix.

Formatdate-time
limit?string

The number of results per page. Minimum value is 1 and maximum is 100. Defaults to 20.

starting_after?string

A cursor value specifying the id of a resource to start before. Retrieves items that appear after this cursor in the list. Cannot be used together with ending_before.

Match^[0-9a-fA-F]{24}$
ending_before?string

A cursor value specifying the id of a resource to end after. Retrieves items that appear before this cursor in the list. Cannot be used together with starting_after.

Match^[0-9a-fA-F]{24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.checkoutpage.com/v1/submissions/"
{
  "has_more": true,
  "total": 0,
  "data": [
    {
      "id": "6812fe6e9f39b6760576f01c",
      "status": "succeeded",
      "sellerId": "string",
      "pageId": "string",
      "customerId": "string",
      "customerEmail": "string",
      "customerName": "string",
      "formTitle": "string",
      "billing": {
        "name": "string",
        "companyName": "string",
        "email": "string",
        "billingEmail": "string",
        "phone": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "shipping": {
        "name": "string",
        "phone": "string",
        "address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "fields": [
        {
          "fieldId": "string",
          "label": "string",
          "value": "string",
          "element": "string",
          "type": "string",
          "meta": {
            "property1": null,
            "property2": null
          },
          "reference": "string"
        }
      ],
      "livemode": true,
      "locale": "string",
      "sessionId": "string",
      "clientIp": "string",
      "userAgent": "string",
      "screenWidth": 0,
      "visitId": "string",
      "queryParameters": {
        "property1": "string",
        "property2": "string"
      },
      "pageSlug": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}