Premiere V2 API

Appearance

List administrators​

GET
/api/v2/administrators

Returns a list of administrators

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Responses​

Administrator list

application/json
JSON
{
  
"count": 10,
  
"totalCount": 25,
  
"limit": 50,
  
"offset": 25,
  
"data": [
  
]
}

Playground​

Authorization

Samples​

Create administrator​

POST
/api/v2/administrators

Create a new administrator

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Created administrator

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

Playground​

Authorization
Body

Samples​

Get administrator by ID​

GET
/api/v2/administrators/{id}

Returns a single administrator by ID

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Administrator ID

Type
integer
Required
Format
"int64"

Responses​

Administrator object

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

Playground​

Authorization
Variables
Key
Value

Samples​

Delete administrator​

DELETE
/api/v2/administrators/{id}

Delete an administrator

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Administrator ID

Type
integer
Required
Format
"int64"

Responses​

Administrator deleted successfully

Playground​

Authorization
Variables
Key
Value

Samples​

Update administrator​

PATCH
/api/v2/administrators/{id}

Update an existing administrator

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Administrator ID

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Updated administrator

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

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Delete multiple administrators​

POST
/api/v2/administrators/bulk-delete

Deletes multiple administrators

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"ids": [
  
  
[
  
  
  
1,
  
  
  
2,
  
  
  
3
  
  
]
  
]
}

Responses​

Administrators deleted successfully

Playground​

Authorization
Body

Samples​

GET /api/v2/administrator/login-report​

GET
/api/v2/administrator/login-report

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

search

Limit to results matching this search string

Type
string
_limit

Limit Results to this number

Type
integer
Format
"int64"
_offset

Offset results by this number

Type
integer
Format
"int64"

Responses​

Playground​

Authorization
Variables
Key
Value

Samples​

Get the permission for the current admin user.​

GET
/api/v2/administrator/my-access

Authorizations​

bearerAuth
Type
HTTP (bearer)

Responses​

An object contains the permissions.

Playground​

Authorization

Samples​

Login a user into the v2 api.​

POST
/api/v2/administrator/login

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_include

Adds additional details to the results. Supports the following values:

  • user - Include additional information about the user login in.
  • perms - Include permssions for the user login in
Type
string

Request Body​

application/json
JSON
{
  
"login": "string",
  
"password": "string"
}

Responses​

Information for the user who's signin in.

application/json
JSON
{
  
"token": "string",
  
"admin": {
  
  
"email": "string"
  
},
  
"perms": {
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Updates the current administrator's password.​

PUT
/api/v2/administrator/password

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"old": "string",
  
"new": "string"
}

Responses​

The password was updated.

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI