Introduction
This documentation aims to provide all the information you need to work with our API.
Authenticating requests
To authenticate requests, include an Authorization
header with the value "Bearer {YOUR_API_TOKEN}"
.
All authenticated endpoints are marked with a requires authentication
badge in the documentation below.
You can generate a token in the administrator dashboard on the bottom of the Settings => Integrations page.
Endpoints
POST api/v1/users/import
requires authentication
Example request:
curl --request POST \
"https://{your-flexopus-domain}/api/v1/users/import" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: multipart/form-data" \
--form "update=1"\
--form "dry_run=1"\
--form "file=@/tmp/phpA94LhO"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/users/import"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
"Content-Type": "multipart/form-data",
};
const body = new FormData();
body.append('update', '1');
body.append('dry_run', '1');
body.append('file', document.querySelector('input[name="file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/users/import';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'multipart/form-data',
],
'multipart' => [
[
'name' => 'update',
'contents' => '1'
],
[
'name' => 'dry_run',
'contents' => '1'
],
[
'name' => 'file',
'contents' => fopen('/tmp/phpA94LhO', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/users/import'
files = {
'update': (None, '1'),
'dry_run': (None, '1'),
'file': open('/tmp/phpA94LhO', 'rb')}
payload = {
"update": true,
"dry_run": true
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json',
'Content-Type': 'multipart/form-data'
}
response = requests.request('POST', url, headers=headers, files=files)
response.json()
Example response (200):
{
"dryRun": true, // dry_run flag from the request
"created": [2, 3], // row indices for freshly created users
"updated": [4, 6], // row indices for updated users
"deleted": 0, // the number of deleted users
"skipped": [5, 8], // row indices for unchanged users
"errors": [7], // indices for rows with errors
"errorMessages": { // object with messages for every error
"7": { // row index of error
"email": [ // column with error
"The email must be a valid email address." // error message
]
}
},
"rows": 7, // total number of processed rows
"filename": "users.csv" // name of the uploaded file
}
Received response:
Request failed with error:
GET api/v1/users/{id}
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/users/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/users/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/users/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/users/1'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()
Example response (200):
{
"data": {
"id": 123,
"name": "Dr. Eddie Torphy IV",
"email": "dr.eddie.torphy.iv@example.com",
"extensionAttributes": {
"extensionAttribute1": "value"
}
}
}
Received response:
Request failed with error:
GET api/v1/users/{user_id}/bookings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/users/1/bookings?from=2021-11-01T00%3A00%3A00Z&to=2021-01-02T00%3A00%3A00Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/users/1/bookings"
);
const params = {
"from": "2021-11-01T00:00:00Z",
"to": "2021-01-02T00:00:00Z",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/users/1/bookings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
'query' => [
'from' => '2021-11-01T00:00:00Z',
'to' => '2021-01-02T00:00:00Z',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/users/1/bookings'
params = {
'from': '2021-11-01T00:00:00Z',
'to': '2021-01-02T00:00:00Z',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
Example response (200):
{
"data": [
{
"id": 18556,
"from": "2021-11-01T08:00:00.000000Z",
"to": null,
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18556/livemap",
"bookable": {
"id": 445,
"name": "Parking spot 2",
"type": 1, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 32,
"name": "Car park 4",
"code": "P4",
"building": {
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
}
}
},
"guest": null,
"license_plate": "AB-CD-123"
},
{
"id": 18596,
"from": "2021-11-02T08:00:00.000000Z",
"to": "2021-11-02T14:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18596/livemap",
"bookable": {
"id": 23,
"name": "Table 12",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 36,
"name": "Office 34",
"code": "O34",
"building": {
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
}
}
},
"guest": null
}
]
}
Received response:
Request failed with error:
GET api/v1/users/by-email/{user_email}
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/users/by-email/zankunding@example.net" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/users/by-email/zankunding@example.net"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/users/by-email/zankunding@example.net';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/users/by-email/zankunding@example.net'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()
Example response (200):
{
"data": {
"id": 123,
"name": "Dr. Eddie Torphy IV",
"email": "dr.eddie.torphy.iv@example.com",
"extensionAttributes": {
"extensionAttribute1": "value"
}
}
}
Received response:
Request failed with error:
GET api/v1/users/by-email/{user_email}/bookings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/users/by-email/fnicolas@example.net/bookings?from=2021-11-01T00%3A00%3A00Z&to=2021-01-02T00%3A00%3A00Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/users/by-email/fnicolas@example.net/bookings"
);
const params = {
"from": "2021-11-01T00:00:00Z",
"to": "2021-01-02T00:00:00Z",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/users/by-email/fnicolas@example.net/bookings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
'query' => [
'from' => '2021-11-01T00:00:00Z',
'to' => '2021-01-02T00:00:00Z',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/users/by-email/fnicolas@example.net/bookings'
params = {
'from': '2021-11-01T00:00:00Z',
'to': '2021-01-02T00:00:00Z',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
Example response (200):
{
"data": [
{
"id": 18556,
"from": "2021-11-01T08:00:00.000000Z",
"to": null,
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18556/livemap",
"bookable": {
"id": 445,
"name": "Parking spot 2",
"type": 1, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 32,
"name": "Car park 4",
"code": "P4",
"building": {
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
}
}
},
"guest": null,
"license_plate": "AB-CD-123"
},
{
"id": 18596,
"from": "2021-11-02T08:00:00.000000Z",
"to": "2021-11-02T14:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18596/livemap",
"bookable": {
"id": 23,
"name": "Table 12",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 36,
"name": "Office 34",
"code": "O34",
"building": {
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
}
}
},
"guest": null
}
]
}
Received response:
Request failed with error:
GET api/v1/buildings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/buildings" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/buildings"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/buildings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/buildings'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()
Example response (200):
{
"data": [
{
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
"locations": [
{
"id": 32,
"name": "Car park 4",
"code": "P4"
},
{
"id": 36,
"name": "Office 34",
"code": "O34"
},
{
"id": 37,
"name": "Office 35",
"code": "O35"
}
]
}
]
}
Received response:
Request failed with error:
GET api/v1/buildings/{building_id}/bookings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/buildings/13/bookings?from=2021-11-01T00%3A00%3A00Z&to=2021-01-02T00%3A00%3A00Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/buildings/13/bookings"
);
const params = {
"from": "2021-11-01T00:00:00Z",
"to": "2021-01-02T00:00:00Z",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/buildings/13/bookings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
'query' => [
'from' => '2021-11-01T00:00:00Z',
'to' => '2021-01-02T00:00:00Z',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/buildings/13/bookings'
params = {
'from': '2021-11-01T00:00:00Z',
'to': '2021-01-02T00:00:00Z',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
Example response (200):
{
"data": [
{
"id": 18552,
"from": "2021-11-01T08:00:00.000000Z",
"to": "2021-11-01T10:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18552/livemap",
"bookable": {
"id": 113,
"name": "Table 24",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 36,
"name": "Office 34",
"code": "O34"
}
},
"user": {
"id": 123,
"name": "Dr. Eddie Torphy IV",
"email": "dr.eddie.torphy.iv@example.com",
"extensionAttributes": {
"extensionAttribute1": "value"
}
},
"guest": null
},
{
"id": 13862,
"from": "2021-11-01T14:00:00.000000Z",
"to": null,
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/13862/livemap",
"bookable": {
"id": 445,
"name": "Parking spot 2",
"type": 1, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 32,
"name": "Car park 4",
"code": "P4"
}
},
"user": {
"id": 127,
"name": "Lillie Bergnaum",
"email": "lillie.bergnaum@example.com",
"extensionAttributes": {
"extensionAttribute3": "other value"
}
},
"guest": null,
"license_plate": null
}
]
}
Received response:
Request failed with error:
GET api/v1/locations/{location_id}/bookings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/locations/3/bookings?from=2021-11-01T00%3A00%3A00Z&to=2021-01-02T00%3A00%3A00Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/locations/3/bookings"
);
const params = {
"from": "2021-11-01T00:00:00Z",
"to": "2021-01-02T00:00:00Z",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/locations/3/bookings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
'query' => [
'from' => '2021-11-01T00:00:00Z',
'to' => '2021-01-02T00:00:00Z',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/locations/3/bookings'
params = {
'from': '2021-11-01T00:00:00Z',
'to': '2021-01-02T00:00:00Z',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
Example response (200):
{
"data": [
{
"id": 18552,
"from": "2021-11-01T08:00:00.000000Z",
"to": "2021-11-01T10:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18552/livemap",
"bookable": {
"id": 113,
"name": "Table 24",
"type": 0 // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
},
"user": {
"id": 123,
"name": "Dr. Eddie Torphy IV",
"email": "dr.eddie.torphy.iv@example.com",
"extensionAttributes": {
"extensionAttribute1": "value"
}
},
"guest": null
},
{
"id": 13862,
"from": "2021-11-01T14:00:00.000000Z",
"to": null,
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/13862/livemap",
"bookable": {
"id": 445,
"name": "Parking spot 2",
"type": 1 // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
},
"user": {
"id": 127,
"name": "Lillie Bergnaum",
"email": "lillie.bergnaum@example.com",
"extensionAttributes": {
"extensionAttribute3": "other value"
}
},
"guest": null,
"license_plate": "AB-CD-123"
}
]
}
Received response:
Request failed with error:
GET api/v1/locations/{location_id}/bookables
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/locations/14/bookables" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/locations/14/bookables"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/locations/14/bookables';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/locations/14/bookables'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()
Example response (200):
{
"data": [
{
"id": 113,
"name": "Table 24",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0, // 0 => Flexible, 1 => Blocked, 2 => Assigned
"tags": [
"Adjustable height",
"Quiet zone"
]
},
{
"id": 445,
"name": "Parking spot 2",
"type": 1, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 2, // 0 => Flexible, 1 => Blocked, 2 => Assigned
"tags": [
"Electric charger"
]
}
]
}
Received response:
Request failed with error:
GET api/v1/locations/{location_id}/bookables/occupancy
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/locations/7/bookables/occupancy" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/locations/7/bookables/occupancy"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/locations/7/bookables/occupancy';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/locations/7/bookables/occupancy'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()
Example response (200):
{
"data": [
{
"id": "1b16aa00-0848-47eb-bbca-0d45f3cd1fc3",
"location_name": "Office 34",
"type": 0 // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"name": "Table 24",
"occupied": false
},
{
"id": "cb56a871-53f5-4f00-83e2-0b5e4e6b6c51",
"location_name": "Car park 4",
"type": 1 // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"name": "Parking spot 2",
"occupied": true
}
]
}
Example response (200, when details=true):
{
"data": [
{
"id": "1b16aa00-0848-47eb-bbca-0d45f3cd1fc3",
"location_name": "Office 34",
"type": 0 // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"name": "Table 24",
"occupied": false,
"booking_current": null,
"booking_next": {
"from_time": "2023-08-16T13:00:00.000000Z",
"to_time": "2023-08-16T16:00:00.000000Z"
}
},
{
"id": "cb56a871-53f5-4f00-83e2-0b5e4e6b6c51",
"location_name": "Car park 4",
"type": 1 // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"name": "Parking spot 2",
"occupied": true,
"booking_current": {
"from_time": "2023-08-16T09:00:00.000000Z",
"to_time": "2023-08-16T12:00:00.000000Z"
}
"booking_next": null
}
]
}
Received response:
Request failed with error:
GET api/v1/bookables/{bookable_id}/bookings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/bookables/1/bookings?from=2021-11-01T00%3A00%3A00Z&to=2021-01-02T00%3A00%3A00Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/bookables/1/bookings"
);
const params = {
"from": "2021-11-01T00:00:00Z",
"to": "2021-01-02T00:00:00Z",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/bookables/1/bookings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
'query' => [
'from' => '2021-11-01T00:00:00Z',
'to' => '2021-01-02T00:00:00Z',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/bookables/1/bookings'
params = {
'from': '2021-11-01T00:00:00Z',
'to': '2021-01-02T00:00:00Z',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
Example response (200):
{
"data": [
{
"id": 18552,
"from": "2021-11-01T08:00:00.000000Z",
"to": "2021-11-01T10:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18552/livemap",
"user": {
"id": 123,
"name": "Dr. Eddie Torphy IV",
"email": "dr.eddie.torphy.iv@example.com",
"extensionAttributes": {
"extensionAttribute1": "value"
}
},
"guest": null
},
{
"id": 13862,
"from": "2021-11-01T14:00:00.000000Z",
"to": null,
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/13862/livemap",
"user": {
"id": 127,
"name": "Lillie Bergnaum",
"email": "lillie.bergnaum@example.com",
"extensionAttributes": {
"extensionAttribute3": "other value"
}
},
"guest": null,
"license_plate": "AB-CD-123"
}
]
}
Received response:
Request failed with error:
PATCH api/v1/bookables/{id}
requires authentication
Example request:
curl --request PATCH \
"https://{your-flexopus-domain}/api/v1/bookables/4" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
\"name\": \"Table 7\",
\"status\": 0
}"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/bookables/4"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
};
let body = {
"name": "Table 7",
"status": 0
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/bookables/4';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
'json' => [
'name' => 'Table 7',
'status' => 0,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/bookables/4'
payload = {
"name": "Table 7",
"status": 0
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json',
'Content-Type': 'application/json'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
Example response (200):
{
"data": {
"id": 30,
"name": "Table 29",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0, // 0 => Flexible, 1 => Blocked, 2 => Assigned
"tags": [
"Adjustable height",
"Quiet zone"
]
}
}
Received response:
Request failed with error:
GET api/v1/bookings
requires authentication
Example request:
curl --request GET \
--get "https://{your-flexopus-domain}/api/v1/bookings?from=2021-11-01T00%3A00%3A00Z&to=2021-01-02T00%3A00%3A00Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/bookings"
);
const params = {
"from": "2021-11-01T00:00:00Z",
"to": "2021-01-02T00:00:00Z",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/bookings';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
'query' => [
'from' => '2021-11-01T00:00:00Z',
'to' => '2021-01-02T00:00:00Z',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/bookings'
params = {
'from': '2021-11-01T00:00:00Z',
'to': '2021-01-02T00:00:00Z',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()
Example response (200):
{
"data": [
{
"id": 18556,
"from": "2021-11-01T08:00:00.000000Z",
"to": null,
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18556/livemap",
"bookable": {
"id": 445,
"name": "Parking spot 2",
"type": 1, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 32,
"name": "Car park 4",
"code": "P4",
"building": {
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
}
}
},
"user": {
"id": 127,
"name": "Lillie Bergnaum",
"email": "lillie.bergnaum@example.com",
"extensionAttributes": {
"extensionAttribute3": "other value"
}
},
"guest": null,
"license_plate": "AB-CD-123"
},
{
"id": 18596,
"from": "2021-11-02T08:00:00.000000Z",
"to": "2021-11-02T14:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/18596/livemap",
"bookable": {
"id": 23,
"name": "Table 12",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 36,
"name": "Office 34",
"code": "O34",
"building": {
"id": 1,
"name": "Building",
"address": "281 Buchanan Rd, Sheffield, CH2 3NH"
}
}
},
"user": {
"id": 123,
"name": "Dr. Eddie Torphy IV",
"email": "dr.eddie.torphy.iv@example.com",
"extensionAttributes": {
"extensionAttribute1": "value"
}
},
"guest": "Irwin Muller"
}
]
}
Received response:
Request failed with error:
POST api/v1/bookings
requires authentication
Example request:
curl --request POST \
"https://{your-flexopus-domain}/api/v1/bookings" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
\"bookable_id\": 30,
\"from_time\": \"2023-08-16T13:00:00.000000Z\",
\"to_time\": \"2023-08-16T16:00:00.000000Z\",
\"user_id\": 10,
\"location_id\": 4,
\"guest_email\": \"johndoe@flexopus.com\",
\"guest_name\": \"John Doe\",
\"booking_info\": \"Meeting with John\",
\"user_vehicle_id\": 1
}"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/bookings"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
};
let body = {
"bookable_id": 30,
"from_time": "2023-08-16T13:00:00.000000Z",
"to_time": "2023-08-16T16:00:00.000000Z",
"user_id": 10,
"location_id": 4,
"guest_email": "johndoe@flexopus.com",
"guest_name": "John Doe",
"booking_info": "Meeting with John",
"user_vehicle_id": 1
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/bookings';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
'json' => [
'bookable_id' => 30,
'from_time' => '2023-08-16T13:00:00.000000Z',
'to_time' => '2023-08-16T16:00:00.000000Z',
'user_id' => 10,
'location_id' => 4,
'guest_email' => 'johndoe@flexopus.com',
'guest_name' => 'John Doe',
'booking_info' => 'Meeting with John',
'user_vehicle_id' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/bookings'
payload = {
"bookable_id": 30,
"from_time": "2023-08-16T13:00:00.000000Z",
"to_time": "2023-08-16T16:00:00.000000Z",
"user_id": 10,
"location_id": 4,
"guest_email": "johndoe@flexopus.com",
"guest_name": "John Doe",
"booking_info": "Meeting with John",
"user_vehicle_id": 1
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json',
'Content-Type': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
Example response (200):
{
"data": [
{
"id": 138,
"from": "2023-08-16T13:00:00.000000Z",
"to": "2023-08-16T16:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/138/livemap",
"bookable": {
"id": 30,
"name": "Table 29",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 4,
"name": "Floor 1",
"code": "FP1"
}
},
"user": {
"id": 10,
"name": "John Doe",
"email": "johndoe@flexopus.com",
"extensionAttributes": {
"extensionAttribute10": "another value"
}
}
}
]
}
Received response:
Request failed with error:
PUT api/v1/bookings/{id}
requires authentication
Example request:
curl --request PUT \
"https://{your-flexopus-domain}/api/v1/bookings/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{
\"from_time\": \"2023-08-16T13:00:00.000000Z\",
\"to_time\": \"2023-08-16T16:00:00.000000Z\",
\"user_vehicle_id\": 1
}"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/bookings/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
};
let body = {
"from_time": "2023-08-16T13:00:00.000000Z",
"to_time": "2023-08-16T16:00:00.000000Z",
"user_vehicle_id": 1
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/bookings/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
'json' => [
'from_time' => '2023-08-16T13:00:00.000000Z',
'to_time' => '2023-08-16T16:00:00.000000Z',
'user_vehicle_id' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/bookings/1'
payload = {
"from_time": "2023-08-16T13:00:00.000000Z",
"to_time": "2023-08-16T16:00:00.000000Z",
"user_vehicle_id": 1
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json',
'Content-Type': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()
Example response (200):
{
"data": {
"id": 138,
"from": "2023-08-16T13:00:00.000000Z",
"to": "2023-08-16T16:00:00.000000Z",
"livemap": "https://{your-flexopus-domain}/api/v1/bookings/138/livemap",
"bookable": {
"id": 30,
"name": "Table 29",
"type": 0, // 0 => Desk, 1 => Parking spot, 2 => Meeting room, 3 => Home office
"status": 0 // 0 => Flexible, 1 => Blocked, 2 => Assigned
"location": {
"id": 4,
"name": "Floor 1",
"code": "FP1"
}
},
"user": {
"id": 10,
"name": "John Doe",
"email": "johndoe@flexopus.com",
"extensionAttributes": {
"extensionAttribute10": "another value"
}
}
}
}
Received response:
Request failed with error:
DELETE api/v1/bookings/{id}
requires authentication
Example request:
curl --request DELETE \
"https://{your-flexopus-domain}/api/v1/bookings/10" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Accept: application/json"
const url = new URL(
"https://{your-flexopus-domain}/api/v1/bookings/10"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://{your-flexopus-domain}/api/v1/bookings/10';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://{your-flexopus-domain}/api/v1/bookings/10'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()
Example response (204):
[Empty response]
Received response:
Request failed with error: