Gang

Gangs are groups of users that can be used to organize users into teams or departments.

Operations

GET/v1/gangs/specGET/v1/gangsPOST/v1/gangsGET/v1/gangs/{gangId}DELETE/v1/gangs/{gangId}PATCH/v1/gangs/{gangId}

---

OpenAPI Spec

GET

/v1/gangs/spec

Get OpenAPI 3.1.0 spec for Gang API

Responses

Returns OpenAPI 3.1.0 spec for Gang API

Content-Type

application/json

{

}

GET

/v1/gangs/spec

Playground

Samples

---

List Gangs

GET

/v1/gangs

List Gangs

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

id

name

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"name": "string",

"order": 0,

"userIds": [

0

],

"deactivatedAt": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

]

}

GET

/v1/gangs

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

id

name

externalId

createdAt

updatedAt

Samples

---

Create a new Gang

POST

/v1/gangs

Create a new Gang

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

"name": "string",

"order": 0,

"userIds": [

0

],

"deactivatedAt": "string",

"externalId": null

}

Responses

Gang found

Content-Type

application/json

{

"id": 0,

"name": "string",

"order": 0,

"userIds": [

0

],

"deactivatedAt": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

POST

/v1/gangs

Playground

Server

Authorization

apiKey

Body

Samples

---

Get a Gang

GET

/v1/gangs/{gangId}

Get a Gang by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

gangId*

Type

integer

Required

Format

"int32"

Responses

Gang found

Content-Type

application/json

{

"id": 0,

"name": "string",

"order": 0,

"userIds": [

0

],

"deactivatedAt": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

GET

/v1/gangs/{gangId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

gangId*

Samples

---

Delete a Gang

DELETE

/v1/gangs/{gangId}

Delete a Gang by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

gangId*

Type

integer

Required

Format

"int32"

Responses

Successfully removed

DELETE

/v1/gangs/{gangId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

gangId*

Samples

---

Update a Gang

PATCH

/v1/gangs/{gangId}

Update a Gang by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

gangId*

Type

integer

Required

Format

"int32"

Request Body

application/json

{

"name": "string",

"deactivatedAt": "string",

"order": 0,

"userIds": [

0

],

"externalId": "string"

}

Responses

Gang found

Content-Type

application/json

{

"id": 0,

"name": "string",

"order": 0,

"userIds": [

0

],

"deactivatedAt": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

PATCH

/v1/gangs/{gangId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

gangId*

Body

Samples

---