List Workspace Units

GET 
/api/v1/workspaces/:workspace/units

List all Units in a Workspace by its ID.

Request

Path Parameters

workspace integerrequired

Possible values: > 0

ID of the Workspace

Query Parameters

size integer
Possible values: > 0 and <= 100
Default value: 100
nextToken string
sortBy string

Possible values: [id, name]

sortOrder string
Possible values: [asc, desc]
Default value: asc

Responses

200

Success

application/json

Schema

Schema

size integerrequired
Possible values: > 0
Example: 100

data

object[]

required

Array [

id integerrequired

ID of the Unit

Possible values: > 0

Example: 1000

name stringrequired

Name of the Unit

Example: Unit 1

]

next

object

token stringrequired

Example: eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K

href urirequired

Example: /workspaces/1000/units/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K

Example (from schema)

{
  "size": 100,
  "data": [
    {
      "id": 1000,
      "name": "Unit 1"
    }
  ],
  "next": {
    "token": "eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K",
    "href": "/workspaces/1000/units/api/v1?size=10&sortBy=name&sortOrder=asc&nextToken=eyJjdXJzb3IiOjEsInRva2VuIjoiIn0K"
  }
}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

Loading...