Workspace

Get Workspaces

A workspace (formerly known as a Schedule) is a collection of resources displayed in a timeline or calendar view on the Schedule, designed to help you manage and visualize resource usage.

Workspaces make it easy to group and organize resources, such as rooms, equipment, or personnel, based on specific criteria like departments, resource types, or office locations.

Additionally, workspaces include access control features, allowing you to restrict viewing and booking permissions to specific users or groups for enhanced security and organization.

READ access to the ADMIN module is required to access this endpoint

GET

workspace

curl --request GET \
  --url https://api.sonderplan.com/v2/workspace \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 9458,
      "name": "Sydney Studio",
      "description": "Sydney Office, Level 2",
      "resources": [
        {
          "id": 9458,
          "name": "Edit Suite 1",
          "description": "Sydney Office, Level 2",
          "type_id": 1,
          "type_person_id": 0,
          "parent_id": 2908,
          "parent_name": "Cameras",
          "updated": 1388552400,
          "icon": [
            {
              "id": 2342354,
              "name": "Avid_Icon",
              "size": 174285,
              "alias": "7e73ab25155974c230d09494548201b9f5056ef",
              "extension": "png",
              "mime_type": "image/png"
            }
          ]
        }
      ],
      "access": [
        {
          "id": 4,
          "acl": "RW",
          "name": "Administrators",
          "type": "group"
        }
      ],
      "feed": "<string>",
      "working_week": 3,
      "country_region": "AU-NSW",
      "show_public_holiday": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

One or more (comma seperated) ids of workspaces to retrieve

fields

string

Comma seperated list of fields you wish to return

page

integer

Specify the page of results you wish to return

limit

integer

The number of results returned per page. Default if not specified is 10

order_asc

string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

order_desc

string

Specify the field (with type of string or integer) you wish to order (descending) the response with

filter_operator

enum<string>

default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:

OR,

AND

Response

200

application/json

Successful Operation

data

object[]

Workspace model

data.id

integer

Automatically generated unique workspace id

Example:

9458

data.name

string

Name of the workspace

Example:

"Sydney Studio"

data.description

string

Additional info about the workspace

Example:

"Sydney Office, Level 2"

data.resources

object[]

The resources that have been assigned to the workspace

Resource model summarised

data.access

object[]

The users and groups who have been given access to the workspace

Users and groups who have access to the object

data.feed

string

iCalendar subscription feed URL (if enabled)

data.working_week

integer

Identifer of one of the following predefined working week templates. 0 = Monday -> Friday (Saturday / Sunday), 1 = Monday -> Saturday (Sunday), 2 = Saturday -> Thursday (Friday), 3 = Sunday -> Thursday (Friday / Saturday)

Example:

3

data.country_region

string

Identifier of the country / state that public holidays should be loaded for. Only required if show_public_holiday = true

Example:

"AU-NSW"

data.show_public_holiday

boolean

Should public holidays be loaded on the workspace

Example:

true

meta

object

Delete Resource Update Workspace

curl --request GET \
  --url https://api.sonderplan.com/v2/workspace \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 9458,
      "name": "Sydney Studio",
      "description": "Sydney Office, Level 2",
      "resources": [
        {
          "id": 9458,
          "name": "Edit Suite 1",
          "description": "Sydney Office, Level 2",
          "type_id": 1,
          "type_person_id": 0,
          "parent_id": 2908,
          "parent_name": "Cameras",
          "updated": 1388552400,
          "icon": [
            {
              "id": 2342354,
              "name": "Avid_Icon",
              "size": 174285,
              "alias": "7e73ab25155974c230d09494548201b9f5056ef",
              "extension": "png",
              "mime_type": "image/png"
            }
          ]
        }
      ],
      "access": [
        {
          "id": 4,
          "acl": "RW",
          "name": "Administrators",
          "type": "group"
        }
      ],
      "feed": "<string>",
      "working_week": 3,
      "country_region": "AU-NSW",
      "show_public_holiday": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Instance

Billable Item

Booking

Calendar Subscription

Contact

Custom Field

Group

Invoice

Quote

Invoice Template

User

Project

Rate Scheme

Resource

Workspace

Status

Tax

Time Activity

Time Entry

Get Workspaces

Authorizations

Query Parameters

Response