Lists company resources

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

offset

number

optional

The offset to start from

Default:

0

Example:

0

limit

number

optional

The limit of items to return

Default:

100

Example:

100

officeId

string

optional

Office id

Example:

100

type

enum<string>

optional

Resource type

Allowed values:

flexDeskmeetingRoomparkingother

zoneId

string

optional

Zone id

Example:

100

Header Params

Authorization

string

required

Public API key for the company

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

List of resources matching the provided filters

Body

data

array[object (ResourceResponse) {12}]

required

List of resources

id

string

required

The ID of the resource

Example:

123e4567-e89b-12d3-a456-426614174000

companyId

string

required

The ID of the company

Example:

123e4567-e89b-12d3-a456-426614174000

type

enum<string>

required

The type of the resource

Allowed values:

flexDeskmeetingRoomparkingother

Example:

flexDesk

capacity

number

required

The capacity of the resource

Example:

1

name

string

required

The name of the resource

Example:

Flex Desk 1

description

string

required

The description of the resource

Example:

Flex Desk 1

status

enum<string>

required

The status of the resource

Allowed values:

activeinactivedeleted

Example:

active

zoneId

string | null

required

The ID of the zone where the resource is located

Example:

12

officeId

string

required

The ID of the office where the resource is located

Example:

13

accessInfo

required

The access information of the resource

createdAt

string <date-time>

required

The time when the resource was created

Example:

2021-01-01T00:00:00.000Z

updatedAt

string <date-time>

required

The time when the resource was updated

Example:

2021-01-01T00:00:00.000Z

offset

number

required

Number of itesm to skip from the filtered results

Example:

0

limit

number

required

Number of items to return from the filtered results

Example:

10

total

number

required

Total number of items that match the filter

Example:

100

Example

{
    "data": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "type": "flexDesk",
            "capacity": 1,
            "name": "Flex Desk 1",
            "description": "Flex Desk 1",
            "status": "active",
            "zoneId": "12",
            "officeId": "13",
            "accessInfo": {},
            "createdAt": "2021-01-01T00:00:00.000Z",
            "updatedAt": "2021-01-01T00:00:00.000Z"
        }
    ],
    "offset": 0,
    "limit": 10,
    "total": 100
}

🟠401Unauthorized

🟠403Forbidden