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.

PreviousSpatial API

Last updated 2 months ago

Was this helpful?

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

GEThttps://api.gospace.app/workplace/v1/location/settings

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/location/settings', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/team/settings

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/team/settings', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/people/settings

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/people/settings', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/allocations

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/allocations', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/intentions

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/intentions', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/forecast

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/forecast', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/occupancy

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/occupancy', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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

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

GEThttps://api.gospace.app/workplace/v1/capacity

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/workplace/v1/capacity', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

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