Skip to content

Retrieve a list of wine clubs

Request

🚦 Rate Limit: 100 requests / minute

Security
BearerAuth
Query
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/wine-clubs?offset=0&pageSize=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A list of wine clubs

Bodyapplication/json
dataArray of objects(WineClub)
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
  }
}