Skip to main content
GET
/
api
/
v1
/
api-keys
/
conventions
Get Store Conventions
curl --request GET \
  --url https://api.example.com/api/v1/api-keys/conventions/ \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "url": "<string>",
    "start_datetime": "2023-11-07T05:31:56Z",
    "end_datetime": "2023-11-07T05:31:56Z",
    "name_of_location": "<string>",
    "address": "<string>"
  }
]

Authorizations

​
X-API-Key
string
header
required

API key in format: sk_*

Query Parameters

​
end_date
string<date-time>

End date for convention range (format: YYYY-MM-DD HH:MM)

​
ongoing
boolean

If true, returns only currently ongoing conventions

​
start_date
string<date-time>

Start date for convention range (format: YYYY-MM-DD HH:MM)

Response

200 - application/json
​
id
integer
required
read-only
​
name
string
required
Maximum string length: 300
​
slug
string
Maximum string length: 350
Pattern: ^[-a-zA-Z0-9_]+$
​
status
enum<string>
  • SCHEDULED - Scheduled
  • CANCELED - Canceled
  • UNLISTED - Unlisted
  • DETAILS_PENDING - Details Pending
  • USE_EXTERNAL_SCHEDULE - Use External Schedule
  • ARCHIVED - Archived
Available options:
SCHEDULED,
CANCELED,
UNLISTED,
DETAILS_PENDING,
USE_EXTERNAL_SCHEDULE,
ARCHIVED
​
description
string | null
​
url
string<uri> | null
Maximum string length: 200
​
start_datetime
string<date-time> | null
​
end_datetime
string<date-time> | null
​
name_of_location
string | null
Maximum string length: 500
​
address
string | null
Maximum string length: 500