Appearance
Account
| Endpoint | Returns | Notes |
|---|---|---|
GET /v1/account | The organiser account, your platform's name and support contact, the capabilities you support with their versions and options, and the shared config, such as your rate limit. | Also our health check, so keep it cheap. |
json
{
"account": { "id": "org_8f2c", "name": "The Crave" },
"provider": {
"name": "TicketCo",
"url": "https://ticketco.example",
"logo": "https://ticketco.example/logo.svg",
"support": {
"email": "partners@ticketco.example",
"url": "https://help.ticketco.example/innercrowd"
}
},
"capabilities": {
"catalogue": { "version": "v1" },
"orders": {
"version": "v1",
"reconciliation": { "enabled": true, "minDelay": 300, "overlap": 300 }
},
"vouchers": {
"version": "v1",
"discountTypes": ["percentage", "fixed"],
"codes": { "length": 12 }
},
"webhooks": { "version": "v1", "setup": "managed" }
},
"config": {
"rateLimit": { "requestsPerMinute": 120 }
}
}Capabilities
One key for each capability you support, holding its options. A capability you leave out is one you don't support, and we never call its endpoints. Every capability has a version, "v1" when you leave it out, and that is the prefix of the paths we call: /v1/orders. /v1/account itself is always v1. Each capability lists its options under Configuration.
Account id
account.id must identify the organiser account in a stable way: it is how we recognise this integration. It never changes for the life of the account, it is the same for every key of that account (a new or rotated key returns the same id), and it is never reused for another account. Connecting the same account twice is recognised as the same integration. A key never gives access to more than that one account.
Config
config holds the settings that apply to every capability. Today that's one, optional: config.rateLimit.requestsPerMinute. When you send it we pace every call to your platform below it: imports, vouchers and webhook fetches, for all organisers together.
Ticket provider info
provider describes your platform. name and url are required. logo is optional: an https link to your logo, SVG or PNG, which we show wherever organisers see your integration in Innercrowd. support.email is required and support.url optional: we show them to the organiser when your API rejects a call or a test fails, and our engineers use them when your implementation needs attention.