Workplace API

The Workplace API is designed to control and manage workplace configurations within a division. It includes entities such as location settings, team settings, people settings, allocations, intentions, forecasting, location capacity, occupancy, and AI evolutions. The API provides endpoints to create, retrieve, update, and delete these workplace-related entities, enabling comprehensive management and organisation of workplace information.

Retrieve a list of location settings or a specific location setting by ID.

get

/location/settings

Authorizations

Query parameters

location_idstring

Optional ID of the location to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/location/settings' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "location_settings": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_location_settings_successful"
}

OK

Retrieve a list of team settings or a specific team setting by ID.

get

/team/settings

Authorizations

Query parameters

team_idstring

ID of the team to retrieve layers from.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/team/settings' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "team_settings": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_team_settings_successful"
}

OK

Retrieve a list of people settings or a specific person setting by ID.

get

/people/settings

Authorizations

Query parameters

people_idstring

ID of the person to retrieve settings for.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/people/settings' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "people_settings": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_people_settings_successful"
}

OK

Retrieve a list of allocations or a specific allocation by ID.

get

/allocations

Authorizations

Query parameters

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

location_idstring

Filter by Location ID.

layer_idstring

Filter by Layer ID.

room_idstring

Filter by Room ID.

zone_idstring

Filter by Zone ID.

people_idstring

Filter by People ID.

team_idstring

Filter by Team ID.

starts_atstring · date-time

Start date-time in UTC.

ends_atstring · date-time

End date-time in UTC.

location_timezonestring

Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.

Example: Europe/London

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/allocations' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "allocations": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_allocations_successful"
}

OK

Retrieve a list of intentions or a specific intention by ID.

get

/intentions

Authorizations

Query parameters

area_idstring

Optional ID of the area to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

location_idstring

Filter by Location ID.

layer_idstring

Filter by Layer ID.

room_idstring

Filter by Room ID.

zone_idstring

Filter by Zone ID.

people_idstring

Filter by People ID.

team_idstring

Filter by Team ID.

starts_atstring · date-time

Start date-time in UTC.

ends_atstring · date-time

End date-time in UTC.

location_timezonestring

Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.

Example: Europe/London

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/intentions' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "intentions": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_intentions_successful"
}

OK

Retrieve a list of forecast or a specific forecast by ID.

get

/forecast

Authorizations

Query parameters

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

location_idstring

Filter by Location ID.

people_idstring

Filter by People ID.

team_idstring

Filter by Team ID.

starts_atstring · date-time

Start date-time in UTC.

ends_atstring · date-time

End date-time in UTC.

location_timezonestring

Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.

Example: Europe/London

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/forecast' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "forecast": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_forecast_successful"
}

OK

Retrieve a list of occupancy or a specific occupancy by ID.

get

/occupancy

Authorizations

Query parameters

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

location_idstring

Filter by Location ID.

people_idstring

Filter by People ID.

starts_atstring · date-time

Start date-time in UTC.

ends_atstring · date-time

End date-time in UTC.

location_timezonestring

Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.

Example: Europe/London

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/occupancy' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "occupancy": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_occupancy_successful"
}

OK

Retrieve a list of capacity or a specific capacity by ID.

get

/capacity

Authorizations

Query parameters

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum · default: asc

Sort order, 'asc' or 'desc'.

Options: asc, desc

location_idstring

Filter by Location ID.

date_fromstring · date

Start date for filtering capacity. Dates are interpreted in UTC.

Example: YYYY-MM-DD or YYYY-DD-MM

date_tostring · date

End date for filtering capacity. Dates are interpreted in UTC.

Example: YYYY-MM-DD or YYYY-DD-MM

location_timezonestring

Timezone of the location. When provided, date_from and date_to are interpreted in this timezone. Must be a valid IANA Time Zone identifier.

Example: Europe/London

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/workplace/v1/capacity' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "capacity": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 20
    }
  },
  "identifier": "get_capacity_successful"
}

OK