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.

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/location/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "location_settings": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/team/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "team_settings": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/people/settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "people_settings": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/allocations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "allocations": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/intentions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "intentions": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/forecast', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "forecast": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/occupancy', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "occupancy": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

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

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/workplace/v1/capacity', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "capacity": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}