Retrieve a list of customers

Request

🚦 Rate Limit: 100 requests / minute

Security

BearerAuth

Query

modifiedFromDatestring, (date-time)

Filter customers modified from this date (ISO 8601 format). Optional - if not provided, no date filtering is applied.

Example:modifiedFromDate=2025-05-01T00:00:00Z

modifiedToDatestring, (date-time)

Filter customers modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate.

Example:modifiedToDate=2025-05-31T23:59:59Z

offsetinteger, >= 0

Number of records to skip for pagination (default: 0)

Example:offset=0

pageSizeinteger, [ 1 .. 1000 ]

Number of records to return per page (default: 1000, max: 1000)

Example:pageSize=50

curl -i -X GET \
  'https://staging.corksy.io/connect-api/v1/customers?modifiedFromDate=2025-05-01T00%3A00%3A00Z&modifiedToDate=2025-05-31T23%3A59%3A59Z&offset=0&pageSize=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A list of customers

Bodyapplication/json

dataArray of objects(Customer)

paginationobject(PaginationInfo)

Response

{
  "data": [
    { … }
  ],
  "pagination": {
    "current_offset": 0,
    "page_size": 50,
    "total_records": 1250,
    "total_pages": 25,
    "current_page": 1,
    "pages_remaining": 24,
    "has_next_page": true,
    "has_previous_page": false
  }
}