Skip to content

Get Box Office settings​

GET
/api/v2/settings/box-office

Get Box Office settings

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

Box Office settings object

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization

Samples​


Update Box Office settings​

PATCH
/api/v2/settings/box-office

Update Box Office settings

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Updated Box Office settings object

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Get Receipt settings​

GET
/api/v2/settings/receipt

Returns Receipt settings

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

Receipt settings

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization

Samples​


Update Receipt settings​

PATCH
/api/v2/settings/receipt

Partial update of Receipt settings.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Settings updated successfully

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Get E Tickets settings​

GET
/api/v2/settings/tickets

Returns E Tickets settings

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

Tickets settings

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization

Samples​


Update Tickets settings​

PATCH
/api/v2/settings/tickets

Partial update of Tickets settings.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Settings updated successfully

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Body

Samples​


Find Settings by Name​

GET
/api/v2/settings/{name}

Returns a single Settings

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

name*

Setting Name

Type
string
Required

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​


Delete one Settings by Setting Name​

DELETE
/api/v2/settings/{name}

Deletes the identified Setting

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

name*

Name of Setting to delete

Type
string
Required

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​


Update a setting​

PATCH
/api/v2/settings/{name}

Updates an existing Settings from the PATCH data

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

name*

Setting Name to update

Type
string
Required

Request Body​

application/json
JSON
{
  
"name": "String",
  
"value": "String",
  
"encrypted": "0"
}

Responses​

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Find a list of Settings by a set of filters​

GET
/api/v2/settings

Returns a list of Settings

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_limit

Set the max number of objects to return

Type
number
Format
"int64"
_offset

Set the number of objects to ignore before starting

Type
number
Format
"int64"
_search

This will only return setting names that contain the string supplied. You can search for multiple values by using a comma (',') as a seperator

Type
string
name

search by setting name

Type
string
value

search by setting value

Type
string
groupSearch

group search can search for multiple values separated by comma and will return all settings within each setting group

Type
string

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​


Create Settings​

POST
/api/v2/settings

Creates a new Settings from the POST data

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Playground​

Authorization
Body

Samples​


Set the value of a global setting​

POST
/api/v2/settings/multiple

Creates or updates a general setting

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
[
]

Responses​

Playground​

Authorization
Body

Samples​


Powered by VitePress OpenAPI