gospace AIDocsAdmin Console

Workplace API

get

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

Authorizations
Query parameters
location_idstringOptional

Optional ID of the location to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
Responses
200
OK
application/json
get
GET /workplace/v1/location/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
team_idstringOptional

ID of the team to retrieve layers from.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
Responses
200
OK
application/json
get
GET /workplace/v1/team/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
people_idstringOptional

ID of the person to retrieve settings for.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
Responses
200
OK
application/json
get
GET /workplace/v1/people/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
location_idstringOptional

Filter by Location ID.

layer_idstringOptional

Filter by Layer ID.

room_idstringOptional

Filter by Room ID.

zone_idstringOptional

Filter by Zone ID.

people_idstringOptional

Filter by People ID.

team_idstringOptional

Filter by Team ID.

starts_atstring · date-timeOptional

Start date-time in UTC.

ends_atstring · date-timeOptional

End date-time in UTC.

location_timezonestringOptional

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
200
OK
application/json
get
GET /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
area_idstringOptional

Optional ID of the area to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
location_idstringOptional

Filter by Location ID.

layer_idstringOptional

Filter by Layer ID.

room_idstringOptional

Filter by Room ID.

zone_idstringOptional

Filter by Zone ID.

people_idstringOptional

Filter by People ID.

team_idstringOptional

Filter by Team ID.

starts_atstring · date-timeOptional

Start date-time in UTC.

ends_atstring · date-timeOptional

End date-time in UTC.

location_timezonestringOptional

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
200
OK
application/json
get
GET /workplace/v1/intentions HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
location_idstringOptional

Filter by Location ID.

people_idstringOptional

Filter by People ID.

team_idstringOptional

Filter by Team ID.

starts_atstring · date-timeOptional

Start date-time in UTC.

ends_atstring · date-timeOptional

End date-time in UTC.

location_timezonestringOptional

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
200
OK
application/json
get
GET /workplace/v1/forecast HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
location_idstringOptional

Filter by Location ID.

people_idstringOptional

Filter by People ID.

starts_atstring · date-timeOptional

Start date-time in UTC.

ends_atstring · date-timeOptional

End date-time in UTC.

location_timezonestringOptional

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
200
OK
application/json
get
GET /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

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

Authorizations
Query parameters
skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Default: ascPossible values:
location_idstringOptional

Filter by Location ID.

date_fromstring · dateOptional

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

Example: YYYY-MM-DD or YYYY-DD-MM
date_tostring · dateOptional

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

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

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
200
OK
application/json
get
GET /workplace/v1/capacity HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

Last updated

Was this helpful?