Workplace API

get

Retrieve team settings.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

team_idstringOptional

external_idstringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/team/settings

HTTPcURLJavaScriptPython

GET /workplace/v1/team/settings HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "team_settings": [
      {
        "team_id": "text",
        "team_name": "text",
        "color": "text",
        "head_count": 1,
        "space_type_preference": "AUTO",
        "default_location": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "linked_locations": [
          "text"
        ],
        "settings": [
          {
            "location_id": "text",
            "type": "text",
            "min_capacity": 1,
            "max_capacity": 1,
            "contingency": 1,
            "fixed_days": [
              1
            ],
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

put

Update team settings.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/team/settings

HTTPcURLJavaScriptPython

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: 186

{
  "team_settings": [
    {
      "team_id": "text",
      "space_type_preference": "AUTO",
      "settings": [
        {
          "location_id": "text",
          "type": "text",
          "min_capacity": 1,
          "max_capacity": 1,
          "contingency": 1,
          "fixed_days": [
            1
          ]
        }
      ]
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "team_id": "text",
      "team_name": "text",
      "color": "text",
      "head_count": 1,
      "space_type_preference": "AUTO",
      "default_location": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "linked_locations": [
        "text"
      ],
      "settings": [
        {
          "location_id": "text",
          "type": "text",
          "min_capacity": 1,
          "max_capacity": 1,
          "contingency": 1,
          "fixed_days": [
            1
          ],
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

post

Create occupancy records.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

location_idstringRequired

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/occupancy

HTTPcURLJavaScriptPython

POST /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "location_id": "text",
  "occupancy": [
    {
      "people_id": "text",
      "seen_at": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": {
    "info": "text",
    "occupancy": [
      {
        "occupancy_id": "text",
        "location_id": "text",
        "people_id": "text",
        "external_ids": [
          "text"
        ],
        "seen_at": "2026-03-02T20:29:08.895Z",
        "created_at": "2026-03-02T20:29:08.895Z",
        "updated_at": "2026-03-02T20:29:08.895Z",
        "door_external_id": "text",
        "wap_external_id": "text",
        "dock_external_id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "identifier": "text"
}

get

Retrieve occupancy records.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

people_idstringOptional

occupancy_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptionalDefault: name

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/occupancy

HTTPcURLJavaScriptPython

GET /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "occupancy": [
      {
        "occupancy_id": "text",
        "location_id": "text",
        "people_id": "text",
        "external_ids": [
          "text"
        ],
        "seen_at": "2026-03-02T20:29:08.895Z",
        "created_at": "2026-03-02T20:29:08.895Z",
        "updated_at": "2026-03-02T20:29:08.895Z",
        "door_external_id": "text",
        "wap_external_id": "text",
        "dock_external_id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

delete

Delete occupancy records.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

location_idstringRequired

timezonestringOptional

people_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/occupancy

HTTPcURLJavaScriptPython

DELETE /workplace/v1/occupancy HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "location_id": "text",
  "timezone": "text",
  "people_id": "text",
  "starts_at": "2026-03-02T20:29:08.895Z",
  "ends_at": "2026-03-02T20:29:08.895Z",
  "occupancy": [
    {
      "occupancy_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": {
    "info": "text",
    "deleted_records": 1
  },
  "identifier": "text"
}

post

Start a forecasting job.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

location_idstringRequired

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

force_rebuildbooleanOptionalDefault: false

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/forecast/start

HTTPcURLJavaScriptPython

POST /workplace/v1/forecast/start HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "location_id": "text",
  "starts_at": "2026-03-02T20:29:08.895Z",
  "ends_at": "2026-03-02T20:29:08.895Z",
  "force_rebuild": false
}

200

OK

{
  "success": true,
  "data": {
    "job_id": "text",
    "location_id": "text",
    "status": "text",
    "service_processing": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "starts_at": "2026-03-02T20:29:08.895Z",
    "ends_at": "2026-03-02T20:29:08.895Z",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve forecasting job status.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

job_idstringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptionalDefault: created_at

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/forecast/status

HTTPcURLJavaScriptPython

GET /workplace/v1/forecast/status HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "forecast_jobs": [
      {
        "job_id": "text",
        "location_id": "text",
        "status": "text",
        "service_processing": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "starts_at": "2026-03-02T20:29:08.895Z",
        "ends_at": "2026-03-02T20:29:08.895Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve forecasted location capacity.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

external_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

timezonestringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptionalDefault: starts_at

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/forecast/locations

HTTPcURLJavaScriptPython

GET /workplace/v1/forecast/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "forecast": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve forecasted team attendance.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

people_idstringOptional

team_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

timezonestringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptionalDefault: starts_at

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/forecast/teams

HTTPcURLJavaScriptPython

GET /workplace/v1/forecast/teams HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "forecast": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve forecasted people attendance.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

people_idstringOptional

team_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

timezonestringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptionalDefault: starts_at

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/forecast/people

HTTPcURLJavaScriptPython

GET /workplace/v1/forecast/people HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "forecast": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

post

Trigger an AIDRA evolution run.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

location_idstringRequired

datestring · date-timeRequired

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/evolve/start

HTTPcURLJavaScriptPython

POST /workplace/v1/evolve/start HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "location_id": "text",
  "date": "2026-03-02T20:29:08.895Z",
  "settings": {
    "disturbance": "MIN",
    "run_by_zone": false,
    "future_days": 0,
    "model": "AIDRA-D1",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

OK

{
  "success": true,
  "data": {
    "evolution_id": "text",
    "status": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve evolution status.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

evolution_idstringRequired

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/evolve/status

HTTPcURLJavaScriptPython

GET /workplace/v1/evolve/status?evolution_id=text HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "evolution_id": "text",
    "status": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

get

Retrieve allocations with filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

room_idstringOptional

zone_idstringOptional

people_idstringOptional

team_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

location_timezonestringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptionalDefault: starts_at

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/allocations

HTTPcURLJavaScriptPython

GET /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "allocations": [
      {
        "allocation_id": "text",
        "location_id": "text",
        "location_name": "text",
        "location_timezone": "text",
        "layer_id": "text",
        "layer_name": "text",
        "room_id": "text",
        "room_name": "text",
        "zone_id": "text",
        "zone_name": "text",
        "team_id": "text",
        "team_name": "text",
        "people_id": "text",
        "people_first_name": "text",
        "people_last_name": "text",
        "people_email": "text",
        "spaces": [],
        "type": "text",
        "starts_at": "2026-03-02T20:29:08.895Z",
        "ends_at": "2026-03-02T20:29:08.895Z",
        "created_at": "2026-03-02T20:29:08.895Z",
        "updated_at": "2026-03-02T20:29:08.895Z",
        "performance": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

post

Create allocations.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/allocations

HTTPcURLJavaScriptPython

POST /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 432

{
  "allocations": [
    {
      "location_id": "text",
      "location_name": "text",
      "location_timezone": "text",
      "layer_id": "text",
      "layer_name": "text",
      "spaces": [],
      "starts_at": "2026-03-02T20:29:08.895Z",
      "ends_at": "2026-03-02T20:29:08.895Z",
      "type": "text",
      "room_id": "text",
      "room_name": "text",
      "zone_id": "text",
      "zone_name": "text",
      "team_id": "text",
      "team_name": "text",
      "people_id": "text",
      "people_first_name": "text",
      "people_last_name": "text",
      "people_email": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "identifier": "text"
}

put

Update allocations.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/allocations

HTTPcURLJavaScriptPython

PUT /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 407

{
  "allocations": [
    {
      "allocation_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "room_id": "text",
      "room_name": "text",
      "zone_id": "text",
      "zone_name": "text",
      "team_id": "text",
      "team_name": "text",
      "people_id": "text",
      "people_first_name": "text",
      "people_last_name": "text",
      "people_email": "text",
      "spaces": [],
      "type": "text",
      "starts_at": "2026-03-02T20:29:08.895Z",
      "ends_at": "2026-03-02T20:29:08.895Z"
    }
  ]
}

200

OK

{
  "success": true,
  "identifier": "text"
}

delete

Delete allocations.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/allocations

HTTPcURLJavaScriptPython

DELETE /workplace/v1/allocations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "allocations": [
    {
      "allocation_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "identifier": "text"
}

get

Retrieve intentions with optional filters. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

external_location_idstringOptional

layer_idstringOptional

room_idstringOptional

zone_idstringOptional

people_idstringOptional

team_idstringOptional

starts_atstring · date-timeOptional

ends_atstring · date-timeOptional

location_timezonestringOptional

external_location_timezonestringOptional

typestringOptional

external_typestringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/intentions

HTTPcURLJavaScriptPython

GET /workplace/v1/intentions HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "intentions": [
      {
        "_id": "text",
        "type": "text",
        "location_id": "text",
        "location_name": "text",
        "location_timezone": "text",
        "status": "text",
        "starts_at": "2026-03-02T20:29:08.895Z",
        "ends_at": "2026-03-02T20:29:08.895Z",
        "people_id": "text",
        "people_first_name": "text",
        "people_last_name": "text",
        "people_email": "text",
        "team_id": "text",
        "team_name": "text",
        "room_id": "text",
        "room_name": "text",
        "invite_list": [],
        "preferences": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "amenities": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "visitors": [],
        "created_at": "2026-03-02T20:29:08.895Z",
        "updated_at": "2026-03-02T20:29:08.895Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "identifier": "text"
}

post

Create an intention. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

forcebooleanOptional

Body

application/json

statusstringOptional

typestringRequired

location_idstringRequired

people_idstringRequired

people_first_namestringRequired

people_last_namestringRequired

people_emailstringRequired

team_idstringOptional

team_namestringOptional

skip_auto_acceptbooleanOptionalDefault: false

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

207

Partial Success

application/json

post

/intentions

HTTPcURLJavaScriptPython

POST /workplace/v1/intentions HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 547

{
  "status": "text",
  "type": "text",
  "location_id": "text",
  "people_id": "text",
  "people_first_name": "text",
  "people_last_name": "text",
  "people_email": "text",
  "team_id": "text",
  "team_name": "text",
  "invite_list": [],
  "preferences": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "amenities": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "visitors": [],
  "dates": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "custom_time": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "skip_auto_accept": false,
  "fixed_day": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "allocation": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "success": true,
  "data": {
    "intentions": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "errors": []
  },
  "identifier": "text"
}

post

Create external intentions. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

207

Partial Success

application/json

post

/intentions/external

HTTPcURLJavaScriptPython

POST /workplace/v1/intentions/external HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "intentions": [
    {
      "people_id": "text",
      "people_email": "text",
      "people_first_name": "text",
      "people_last_name": "text",
      "starts_at": "2026-03-02T20:29:08.895Z",
      "ends_at": "2026-03-02T20:29:08.895Z",
      "external_location_id": "text",
      "external_location_name": "text",
      "external_location_timezone": "text",
      "external_type": "text"
    }
  ]
}

{
  "success": true,
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Accept an intention. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

intention_idstringRequired

Query parameters

forcestringOptionalDefault: false

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

409

Conflicting intentions detected

application/json

put

/intentions/{intention_id}/accept

HTTPcURLJavaScriptPython

PUT /workplace/v1/intentions/{intention_id}/accept HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "_id": "text",
    "status": "text",
    "allocation": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "allcoated_at": "text"
  },
  "identifier": "text"
}

put

Decline an intention. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

intention_idstringRequired

Body

application/json

reasonstringOptional

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/intentions/{intention_id}/decline

HTTPcURLJavaScriptPython

PUT /workplace/v1/intentions/{intention_id}/decline HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "reason": "text"
}

200

OK

{
  "success": true,
  "data": {
    "_id": "text",
    "status": "text",
    "reason": "text"
  },
  "identifier": "text"
}

put

Cancel an intention. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

intention_idstringRequired

Body

application/json

reasonstringOptional

cancel_for_allbooleanOptional

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/intentions/{intention_id}/cancel

HTTPcURLJavaScriptPython

PUT /workplace/v1/intentions/{intention_id}/cancel HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "reason": "text",
  "cancel_for_all": true
}

200

OK

{
  "success": true,
  "data": {
    "_id": "text",
    "status": "text",
    "reason": "text"
  },
  "identifier": "text"
}

delete

Delete an intention. Only LIVE configuration is supported; scenario keys are ignored.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Path parameters

intention_idstringRequired

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/intentions/{intention_id}

HTTPcURLJavaScriptPython

DELETE /workplace/v1/intentions/{intention_id} HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "_id": "text"
  },
  "identifier": "text"
}