Get
curl --request GET \
--url https://api.sortx.co.uk/workspace-settings \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/workspace-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/workspace-settings"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"revision": 123,
"workspace": {
"displayName": "<string>",
"website": "<string>",
"timezone": "<string>",
"defaultBranchId": "<string>",
"defaultBrandId": "<string>"
},
"focus": "full",
"branches": [
{
"id": "<string>",
"name": "<string>",
"address": "<string>",
"town": "<string>",
"postcode": "<string>",
"phone": "<string>",
"email": "<string>",
"managerId": "<string>",
"managerStaffId": "<string>",
"active": true
}
],
"brands": [
{
"id": "<string>",
"name": "<string>",
"tagline": "<string>",
"logoText": "<string>",
"website": "<string>",
"primaryColor": "<string>",
"accentColor": "<string>",
"active": true
}
],
"registered": {
"companyName": "<string>",
"companyNumber": "<string>",
"companyAddress": "<string>"
},
"canManage": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}workspace-settings
Get
Read the workspace presentation, branches and brands
GET
/
workspace-settings
Get
curl --request GET \
--url https://api.sortx.co.uk/workspace-settings \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/workspace-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/workspace-settings"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"revision": 123,
"workspace": {
"displayName": "<string>",
"website": "<string>",
"timezone": "<string>",
"defaultBranchId": "<string>",
"defaultBrandId": "<string>"
},
"focus": "full",
"branches": [
{
"id": "<string>",
"name": "<string>",
"address": "<string>",
"town": "<string>",
"postcode": "<string>",
"phone": "<string>",
"email": "<string>",
"managerId": "<string>",
"managerStaffId": "<string>",
"active": true
}
],
"brands": [
{
"id": "<string>",
"name": "<string>",
"tagline": "<string>",
"logoText": "<string>",
"website": "<string>",
"primaryColor": "<string>",
"accentColor": "<string>",
"active": true
}
],
"registered": {
"companyName": "<string>",
"companyNumber": "<string>",
"companyAddress": "<string>"
},
"canManage": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Response
Success
Show child attributes
Show child attributes
Available options:
full Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes