Workplace API
Retrieve a list of location settings or a specific location setting by ID.
Optional ID of the location to retrieve settings for.
Number of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by.
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/location/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"location_settings": [
{
"_id": "loc-setting-1",
"location_id": "loc-1",
"settings": {
"name": "London Office",
"timezone": "Europe/London",
"details": {
"capacity": 100
}
}
},
{
"_id": "loc-setting-2",
"location_id": "loc-2",
"settings": {
"name": "Paris Office",
"timezone": "Europe/Paris",
"details": {
"capacity": 50
}
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_location_settings_successful"
}Update multiple existing location settings.
OK
Bad Request
Not Found
PUT /workplace/v1/location/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 308
{
"location_settings": [
{
"_id": "loc-setting-1",
"location_id": "loc-1",
"settings": {
"name": "London Office Updated",
"timezone": "Europe/London",
"details": {
"capacity": 120
}
}
},
{
"_id": "loc-setting-2",
"location_id": "loc-2",
"settings": {
"name": "Paris Office Updated",
"timezone": "Europe/Paris",
"details": {
"capacity": 60
}
}
}
]
}{
"success": true,
"data": {
"location_settings": [
{
"_id": "loc-setting-1",
"location_id": "loc-1",
"settings": {
"name": "London Office Updated",
"timezone": "Europe/London",
"details": {
"capacity": 120
}
}
},
{
"_id": "loc-setting-2",
"location_id": "loc-2",
"settings": {
"name": "Paris Office Updated",
"timezone": "Europe/Paris",
"details": {
"capacity": 60
}
}
}
]
},
"identifier": "update_location_settings_successful"
}Retrieve a list of team settings or a specific team setting by ID, with optional filter for external ID.
Optional ID of the team to retrieve settings for.
Optional external ID to filter team settings (matches team's external_id).
Number of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by.
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/team/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"team_settings": [
{
"_id": "team-setting-1",
"team_id": "team-1",
"external_id": "ext-456",
"settings": {
"team_name": "Accounting",
"details": {
"priority": "high"
}
}
},
{
"_id": "team-setting-2",
"team_id": "team-2",
"external_id": "ext-789",
"settings": {
"team_name": "Planning",
"details": {
"priority": "medium"
}
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_team_settings_successful"
}Update multiple existing team settings.
OK
Bad Request
Not Found
PUT /workplace/v1/team/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 304
{
"team_settings": [
{
"_id": "team-setting-1",
"team_id": "team-1",
"external_id": "ext-456",
"settings": {
"team_name": "Accounting Updated",
"details": {
"priority": "high"
}
}
},
{
"_id": "team-setting-2",
"team_id": "team-2",
"external_id": "ext-789",
"settings": {
"team_name": "Planning Updated",
"details": {
"priority": "low"
}
}
}
]
}{
"success": true,
"data": {
"team_settings": [
{
"_id": "team-setting-1",
"team_id": "team-1",
"external_id": "ext-456",
"settings": {
"team_name": "Accounting Updated",
"details": {
"priority": "high"
}
}
},
{
"_id": "team-setting-2",
"team_id": "team-2",
"external_id": "ext-789",
"settings": {
"team_name": "Planning Updated",
"details": {
"priority": "low"
}
}
}
]
},
"identifier": "update_team_settings_successful"
}Retrieve a list of people settings or a specific person setting by ID, with optional filter for external ID.
Optional ID of the person to retrieve settings for.
Optional external ID to filter people settings (matches person's external_id).
Number of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by.
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/people/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"people_settings": [
{
"_id": "person-setting-1",
"people_id": "person-1",
"external_id": "ext-123",
"settings": {
"first_name": "Christian",
"last_name": "Marca",
"email": "[email protected]",
"details": {
"role": "Manager"
}
}
},
{
"_id": "person-setting-2",
"people_id": "person-2",
"external_id": "ext-124",
"settings": {
"first_name": "Alex",
"last_name": "Smith",
"email": "[email protected]",
"details": {
"role": "Employee"
}
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_people_settings_successful"
}Update multiple existing people settings.
OK
Bad Request
Not Found
PUT /workplace/v1/people/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 425
{
"people_settings": [
{
"_id": "person-setting-1",
"people_id": "person-1",
"external_id": "ext-123",
"settings": {
"first_name": "Christian",
"last_name": "Marca Updated",
"email": "[email protected]",
"details": {
"role": "Senior Manager"
}
}
},
{
"_id": "person-setting-2",
"people_id": "person-2",
"external_id": "ext-124",
"settings": {
"first_name": "Alex",
"last_name": "Smith Updated",
"email": "[email protected]",
"details": {
"role": "Senior Employee"
}
}
}
]
}{
"success": true,
"data": {
"people_settings": [
{
"_id": "person-setting-1",
"people_id": "person-1",
"external_id": "ext-123",
"settings": {
"first_name": "Christian",
"last_name": "Marca Updated",
"email": "[email protected]",
"details": {
"role": "Senior Manager"
}
}
},
{
"_id": "person-setting-2",
"people_id": "person-2",
"external_id": "ext-124",
"settings": {
"first_name": "Alex",
"last_name": "Smith Updated",
"email": "[email protected]",
"details": {
"role": "Senior Employee"
}
}
}
]
},
"identifier": "update_people_settings_successful"
}Retrieve a list of allocations or a specific allocation by ID, with optional filters for location, layer, room, zone, people, team, external ID, or date range.
Optional ID of the allocation to retrieve.
Filter by Location ID.
Filter by Layer ID.
Filter by Room ID.
Filter by Zone ID.
Filter by People ID.
Filter by Team ID.
Optional external ID to filter allocations (matches external_id of PERSON or TEAM).
Start date-time in UTC for filtering allocations.
End date-time in UTC for filtering allocations.
Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.
Europe/LondonNumber of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by (e.g., starts_at, people_id).
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"allocations": [
{
"_id": "alloc-1",
"location_id": "loc-1",
"room_id": "room-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"type": "desk"
}
},
{
"_id": "alloc-2",
"location_id": "loc-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"type": "meeting"
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_allocations_successful"
}Create multiple new allocations.
Created
Bad Request
POST /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 365
{
"allocations": [
{
"location_id": "loc-1",
"room_id": "room-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"type": "desk"
}
},
{
"location_id": "loc-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"type": "meeting"
}
}
]
}{
"success": true,
"data": {
"allocations": [
{
"_id": "alloc-1",
"location_id": "loc-1",
"room_id": "room-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"type": "desk"
}
},
{
"_id": "alloc-2",
"location_id": "loc-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"type": "meeting"
}
}
]
},
"identifier": "create_allocations_successful"
}Update multiple existing allocations.
OK
Bad Request
Not Found
PUT /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 397
{
"allocations": [
{
"_id": "alloc-1",
"location_id": "loc-1",
"room_id": "room-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T10:00:00Z",
"ends_at": "2025-07-18T18:00:00Z",
"details": {
"type": "desk"
}
},
{
"_id": "alloc-2",
"location_id": "loc-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T10:00:00Z",
"ends_at": "2025-07-19T18:00:00Z",
"details": {
"type": "meeting"
}
}
]
}{
"success": true,
"data": {
"allocations": [
{
"_id": "alloc-1",
"location_id": "loc-1",
"room_id": "room-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T10:00:00Z",
"ends_at": "2025-07-18T18:00:00Z",
"details": {
"type": "desk"
}
},
{
"_id": "alloc-2",
"location_id": "loc-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T10:00:00Z",
"ends_at": "2025-07-19T18:00:00Z",
"details": {
"type": "meeting"
}
}
]
},
"identifier": "update_allocations_successful"
}Delete multiple allocations by their IDs.
OK
Bad Request
Not Found
DELETE /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"allocations": [
{
"allocation_id": "alloc-1"
},
{
"allocation_id": "alloc-2"
}
]
}{
"success": true,
"data": {
"allocations": [
{
"allocation_id": "alloc-1"
},
{
"allocation_id": "alloc-2"
}
]
},
"identifier": "delete_allocations_successful"
}Retrieve a list of intentions or a specific intention by ID, with optional filters for area, location, layer, room, zone, people, team, external ID, or date range.
Optional ID of the intention to retrieve.
Optional ID of the area to filter intentions.
Filter by Location ID.
Filter by Layer ID.
Filter by Room ID.
Filter by Zone ID.
Filter by People ID.
Filter by Team ID.
Optional external ID to filter intentions (matches external_id of PERSON or TEAM).
Start date-time in UTC for filtering intentions.
End date-time in UTC for filtering intentions.
Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.
Europe/LondonNumber of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by (e.g., starts_at, people_id).
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/intentions HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"intentions": [
{
"_id": "intent-1",
"area_id": "area-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"purpose": "work"
}
},
{
"_id": "intent-2",
"area_id": "area-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"purpose": "meeting"
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_intentions_successful"
}Retrieve a list of forecasts or a specific forecast by ID, with optional filters for location, people, team, external ID, or date range.
Optional ID of the forecast to retrieve.
Filter by Location ID.
Filter by People ID.
Filter by Team ID.
Optional external ID to filter forecasts (matches external_id of PERSON or TEAM).
Start date-time in UTC for filtering forecasts.
End date-time in UTC for filtering forecasts.
Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.
Europe/LondonNumber of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by (e.g., starts_at, people_id).
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/forecast HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"forecast": [
{
"_id": "forecast-1",
"location_id": "loc-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T00:00:00Z",
"ends_at": "2025-07-18T23:59:59Z",
"details": {
"expected_occupancy": 50
}
},
{
"_id": "forecast-2",
"location_id": "loc-2",
"team_id": "team-1",
"external_id": "ext-456",
"starts_at": "2025-07-19T00:00:00Z",
"ends_at": "2025-07-19T23:59:59Z",
"details": {
"expected_occupancy": 75
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_forecast_successful"
}Retrieve a list of occupancy records or a specific occupancy by ID, with optional filters for location, people, external ID, or date range.
Optional ID of the occupancy to retrieve.
Filter by Location ID.
Filter by People ID.
Optional external ID to filter occupancy (matches external_id of PERSON).
Start date-time in UTC for filtering occupancy.
End date-time in UTC for filtering occupancy.
Timezone of the location. When provided, starts_at and ends_at are interpreted in this timezone. Must be a valid IANA Time Zone identifier.
Europe/LondonNumber of items to skip for pagination.
0Maximum number of items to return.
25Field to sort by (e.g., starts_at, people_id).
Sort order, 'asc' or 'desc'.
ascPossible values: OK
Bad Request
GET /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*
{
"success": true,
"data": {
"occupancy": [
{
"_id": "occ-1",
"location_id": "loc-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"status": "present"
}
},
{
"_id": "occ-2",
"location_id": "loc-2",
"people_id": "person-2",
"external_id": "ext-124",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"status": "present"
}
}
],
"pagination": {
"current_results": {
"from": 1,
"to": 25
},
"total_results": 20
}
},
"identifier": "get_occupancy_successful"
}Create multiple new occupancy records.
Created
Bad Request
POST /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 355
{
"occupancy": [
{
"location_id": "loc-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"status": "present"
}
},
{
"location_id": "loc-2",
"people_id": "person-2",
"external_id": "ext-124",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"status": "present"
}
}
]
}{
"success": true,
"data": {
"occupancy": [
{
"_id": "occ-1",
"location_id": "loc-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T09:00:00Z",
"ends_at": "2025-07-18T17:00:00Z",
"details": {
"status": "present"
}
},
{
"_id": "occ-2",
"location_id": "loc-2",
"people_id": "person-2",
"external_id": "ext-124",
"starts_at": "2025-07-19T09:00:00Z",
"ends_at": "2025-07-19T17:00:00Z",
"details": {
"status": "present"
}
}
]
},
"identifier": "create_occupancy_successful"
}Update multiple existing occupancy records.
OK
Bad Request
Not Found
PUT /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 383
{
"occupancy": [
{
"_id": "occ-1",
"location_id": "loc-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T10:00:00Z",
"ends_at": "2025-07-18T18:00:00Z",
"details": {
"status": "present"
}
},
{
"_id": "occ-2",
"location_id": "loc-2",
"people_id": "person-2",
"external_id": "ext-124",
"starts_at": "2025-07-19T10:00:00Z",
"ends_at": "2025-07-19T18:00:00Z",
"details": {
"status": "present"
}
}
]
}{
"success": true,
"data": {
"occupancy": [
{
"_id": "occ-1",
"location_id": "loc-1",
"people_id": "person-1",
"external_id": "ext-123",
"starts_at": "2025-07-18T10:00:00Z",
"ends_at": "2025-07-18T18:00:00Z",
"details": {
"status": "present"
}
},
{
"_id": "occ-2",
"location_id": "loc-2",
"people_id": "person-2",
"external_id": "ext-124",
"starts_at": "2025-07-19T10:00:00Z",
"ends_at": "2025-07-19T18:00:00Z",
"details": {
"status": "present"
}
}
]
},
"identifier": "update_occupancy_successful"
}Delete multiple occupancy records by their IDs.
OK
Bad Request
Not Found
DELETE /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"occupancy": [
{
"occupancy_id": "occ-1"
},
{
"occupancy_id": "occ-2"
}
]
}{
"success": true,
"data": {
"occupancy": [
{
"occupancy_id": "occ-1"
},
{
"occupancy_id": "occ-2"
}
]
},
"identifier": "delete_occupancy_successful"
}Last updated
Was this helpful?