Gang

Fixed crews of users. Assigning a gang to an assignment event assigns its members with it.

Operations

GET/v2/gangs/specGET/v2/gangsPOST/v2/gangsGET/v2/gangs/{gangUuid}DELETE/v2/gangs/{gangUuid}PATCH/v2/gangs/{gangUuid}

---

OpenAPI Spec

GET

/v2/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

/v2/gangs/spec

Playground

Samples

---

List Gangs

GET

/v2/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

uuid

name

externalId

deactivatedAt

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"order": 0,

  

  

  

"userUuids": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"deactivatedAt": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"externalId": "string"

  

  

}

  

]

}

GET

/v2/gangs

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

name

externalId

deactivatedAt

createdAt

updatedAt

Samples

---

Create a new Gang

POST

/v2/gangs

Create a new Gang

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"order": 0,

  

"userUuids": [

  

  

"string"

  

],

  

"deactivatedAt": "string",

  

"externalId": null

}

Responses

Gang found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"order": 0,

  

"userUuids": [

  

  

"string"

  

],

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"externalId": "string"

}

POST

/v2/gangs

Playground

Server

Authorization

apiKey

Body

Samples

---

Get a Gang

GET

/v2/gangs/{gangUuid}

Get a Gang by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

gangUuid*

Type

string

Required

Format

"uuid"

Responses

Gang found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"order": 0,

  

"userUuids": [

  

  

"string"

  

],

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"externalId": "string"

}

GET

/v2/gangs/{gangUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

gangUuid*

Samples

---

Delete a Gang

DELETE

/v2/gangs/{gangUuid}

Delete a Gang by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

gangUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully removed

DELETE

/v2/gangs/{gangUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

gangUuid*

Samples

---

Update a Gang

PATCH

/v2/gangs/{gangUuid}

Update a Gang by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

gangUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"deactivatedAt": "string",

  

"order": 0,

  

"userUuids": [

  

  

"string"

  

],

  

"externalId": "string"

}

Responses

Gang found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"order": 0,

  

"userUuids": [

  

  

"string"

  

],

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"externalId": "string"

}

PATCH

/v2/gangs/{gangUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

gangUuid*

Body

Samples

---