API
Download OpenAPI specification:Download
Get all lobbies
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
[- {
- "id": 0,
- "name": "string",
- "url": "string",
- "description": "string",
- "showPosInQ": true,
- "playQJoinSound": true,
- "agentIds": [
- 0
], - "guestIds": [
- 0
]
}
]Create lobby
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
| name | string |
| description | string |
| omitMainLobbyLink | boolean |
| showPosInQ | boolean |
| playQJoinSound | boolean |
| agentIds | Array of numbers |
| guestIds | Array of numbers |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "omitMainLobbyLink": true,
- "showPosInQ": true,
- "playQJoinSound": true,
- "agentIds": [
- 0
], - "guestIds": [
- 0
]
}Response samples
- 200
{- "id": 0
}Get one lobby
path Parameters
| lobbyId required | string Lobby ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
{- "id": 0,
- "name": "string",
- "url": "string",
- "description": "string",
- "showPosInQ": true,
- "playQJoinSound": true,
- "agents": [
- 0
], - "guests": [
- 0
]
}Edit a lobby
path Parameters
| lobbyId required | string Lobby ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
| name | string |
| description | string |
| omitMainLobbyLink | boolean |
| showPosInQ | boolean |
| playQJoinSound | boolean |
| agents | Array of numbers |
| guests | Array of numbers |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "omitMainLobbyLink": true,
- "showPosInQ": true,
- "playQJoinSound": true,
- "agents": [
- 0
], - "guests": [
- 0
]
}Delete a lobby
path Parameters
| lobbyId required | string Lobby ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Get all agents
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
[- {
- "id": 0,
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "ssn": "string",
- "hsaid": "string",
- "role": "string",
- "lobbies": [
- 0
]
}
]Create an agent
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
string | |
| firstName | string |
| lastName | string |
| ssn | string |
| hsaid | string |
| role | string |
| lobbies | Array of numbers |
Responses
Request samples
- Payload
{- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "ssn": "string",
- "hsaid": "string",
- "role": "string",
- "lobbies": [
- 0
]
}Response samples
- 200
{- "id": 0
}Get one agent
path Parameters
| agentId required | string Agent ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
{- "id": 0,
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "ssn": "string",
- "hsaid": "string",
- "role": "string",
- "lobbies": [
- 0
]
}Edit an agent
path Parameters
| agentId required | string Agent ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
string | |
| firstName | string |
| lastName | string |
| ssn | string |
| hsaid | string |
| role | string |
| lobbies | Array of numbers |
Responses
Request samples
- Payload
{- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "ssn": "string",
- "hsaid": "string",
- "role": "string",
- "lobbies": [
- 0
]
}Delete an agent
path Parameters
| agentId required | string Agent ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Add an agent to a lobby
path Parameters
| agentId required | string Agent ID |
| lobbyId required | string Lobby ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Remove an agent from a lobby
path Parameters
| agentId required | string Agent ID |
| lobbyId required | string Lobby ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Get all guests
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
[- {
- "id": 0,
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "lobbies": [
- 0
], - "owners": [
- 0
]
}
]Create guest
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
string | |
| firstName | string |
| lastName | string |
| phone | string |
| agentId | number |
| lobbies | Array of numbers |
Responses
Request samples
- Payload
{- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "agentId": 0,
- "lobbies": [
- 0
]
}Response samples
- 200
{- "id": 0
}Get one guest
path Parameters
| guestId required | string Guest ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
{- "id": 0,
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "lobbies": [
- 0
], - "owners": [
- 0
]
}Edit a guest
path Parameters
| guestId required | string Guest ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
string | |
| firstName | string |
| lastName | string |
| phone | string |
| agentId | number |
| lobbies | Array of numbers |
Responses
Request samples
- Payload
{- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "agentId": 0,
- "lobbies": [
- 0
]
}Delete a guest
path Parameters
| guestId required | string Guest ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Get all links
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
[- {
- "id": 0,
- "url": "string",
- "name": "string",
- "description": "string",
- "createdBy": "string",
- "validFrom": "string",
- "expiresAt": "string",
- "clicksRemaining": 0
}
]Create link
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
| agentId | number |
| url | string |
| name | string |
| description | string |
| isLimited | boolean |
| validFrom | string |
| expiresAt | string |
| clicksRemaining | number |
Responses
Request samples
- Payload
{- "agentId": 0,
- "url": "string",
- "name": "string",
- "description": "string",
- "isLimited": true,
- "validFrom": "string",
- "expiresAt": "string",
- "clicksRemaining": 0
}Response samples
- 200
{- "id": 0
}Get one link
path Parameters
| linkId required | string Link ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Responses
Response samples
- 200
{- "id": 0,
- "url": "string",
- "name": "string",
- "description": "string",
- "createdBy": "string",
- "validFrom": "string",
- "expiresAt": "string",
- "clicksRemaining": 0
}Edit a link
path Parameters
| linkId required | string Link ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |
Request Body schema: application/json
| agentId | number |
| url | string |
| name | string |
| description | string |
| isLimited | boolean |
| validFrom | string |
| expiresAt | string |
| clicksRemaining | number |
Responses
Request samples
- Payload
{- "agentId": 0,
- "url": "string",
- "name": "string",
- "description": "string",
- "isLimited": true,
- "validFrom": "string",
- "expiresAt": "string",
- "clicksRemaining": 0
}Delete a link
path Parameters
| linkId required | string Link ID |
query Parameters
| organisationName required | string The short name for the organisation |
header Parameters
| Authorization required | string The authorization header containing your API key in the format: |
| X-Secret required | string The API secret key associated with your account. |