v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

AdministratorGroups

Endpoints to interact with administrator groups

Operations

GET/api/v2/administrator-groupsPOST/api/v2/administrator-groupsGET/api/v2/administrator-groups/{id}DELETE/api/v2/administrator-groups/{id}PATCH/api/v2/administrator-groups/{id}

---

List administrator groups

GET

/api/v2/administrator-groups

Returns a list of administrator groups

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Administrator group list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/administrator-groups

Playground

Authorization

bearerAuth

Samples

---

Create administrator group

POST

/api/v2/administrator-groups

Create a new administrator group

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created administrator group

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/administrator-groups

Playground

Authorization

bearerAuth

Body

Samples

---

Get administrator group by ID

GET

/api/v2/administrator-groups/{id}

Returns a single administrator group by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Administrator Group ID

Type

integer

Required

Format

"int64"

Responses

Administrator group object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/administrator-groups/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete administrator group

DELETE

/api/v2/administrator-groups/{id}

Delete an administrator group

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Administrator Group ID

Type

integer

Required

Format

"int64"

Responses

Administrator group deleted successfully

DELETE

/api/v2/administrator-groups/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update administrator group

PATCH

/api/v2/administrator-groups/{id}

Update an existing administrator group

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Administrator Group ID

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated administrator group

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/administrator-groups/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Powered by VitePress OpenAPI