Resource

Get Resources

In Sonderplan, resources refer to any item or entity that can be booked, such as rooms, people, equipment, or actions like recreation and sick leave.

For people resources, it’s recommended to link them to a corresponding contact record using the type_person_id attribute.

Resources can be organized into hierarchical groups using the parent_id attribute, which enables the visual nesting of similar resources for better organization.

Additionally, resources must be assigned to at least one schedule to appear in the resource selection menu in Sonderplan.

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

GET

resource

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

{
  "data": [
    {
      "id": 9458,
      "name": "Edit Suite 1",
      "description": "Sydney Office, Level 2",
      "type_id": 1,
      "type_person_id": 0,
      "parent_id": 2908,
      "order": 4,
      "feed": "/feed/resource/0d17a654166d49a4337b65256...",
      "icon": [
        {
          "id": 2342354,
          "name": "Avid_Icon",
          "size": 174285,
          "alias": "7e73ab25155974c230d09494548201b9f5056ef",
          "extension": "png",
          "mime_type": "image/png"
        }
      ],
      "workspaces": [
        {
          "id": 9458,
          "name": "Sydney Studio",
          "description": "Sydney Office, Level 2"
        }
      ],
      "rates": [
        {
          "id": 9458,
          "type_id": 9,
          "hour_buy_cost": 62.2,
          "hour_sell_cost": 100,
          "day_buy_cost": 560,
          "day_sell_cost": 1000,
          "week_buy_cost": 1000,
          "week_sell_cost": 3500,
          "date_start": "2023-01-01",
          "date_end": "2023-12-31",
          "taxes": [
            {
              "id": 3247,
              "name": "GST",
              "rate": "10.00",
              "total": "151.00"
            }
          ],
          "currency": "AUD"
        }
      ],
      "color_background": "#B0A7F1",
      "color_text": "#000000",
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "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 resources 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[]

Resource model

data.id

integer

Automatically generated unique resource id

Example:

9458

data.name

string

Name of the resource

Example:

"Edit Suite 1"

data.description

string

Additional info about the resource

Example:

"Sydney Office, Level 2"

data.type_id

enum<integer>

1 = Room, 2 = Person, 3 = Equipment, 4 = Resource Group, 5 = Action

Available options:

1,

2,

3,

4,

5

Example:

1

data.type_person_id

integer

Unique id of the person (only applies if this resource is a person)

Example:

0

data.parent_id

integer

Unique id of the resource group that this resource is a child of

Example:

2908

data.order

integer

Order of the resource in relation to other resources in the same group

Example:

4

data.feed

string

iCalendar calendar feed URL. Contains all bookings that are booked to this resource

Example:

"/feed/resource/0d17a654166d49a4337b65256..."

data.icon

object[]

Simplified file model containing only a subset of fields

data.workspaces

object[]

Workspace model summarised

data.rates

object[]

Optional. Specify in the field parameter to return

Single resource rate model

data.color_background

string

Hex color value of the background

Example:

"#B0A7F1"

data.color_text

string

Hex color value of the text

Example:

"#000000"

data.created_id

integer

The unique ID of the person (user) who created this record

Example:

3

data.created

integer

The UNIX time value of the creation time

Example:

1388552400

data.updated_id

integer

The unique ID of the person (user) who last updated this record

Example:

3

data.updated

integer

The UNIX time value of the last update

Example:

1388552400

meta

object

Delete Rate Scheme Update Resource

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

{
  "data": [
    {
      "id": 9458,
      "name": "Edit Suite 1",
      "description": "Sydney Office, Level 2",
      "type_id": 1,
      "type_person_id": 0,
      "parent_id": 2908,
      "order": 4,
      "feed": "/feed/resource/0d17a654166d49a4337b65256...",
      "icon": [
        {
          "id": 2342354,
          "name": "Avid_Icon",
          "size": 174285,
          "alias": "7e73ab25155974c230d09494548201b9f5056ef",
          "extension": "png",
          "mime_type": "image/png"
        }
      ],
      "workspaces": [
        {
          "id": 9458,
          "name": "Sydney Studio",
          "description": "Sydney Office, Level 2"
        }
      ],
      "rates": [
        {
          "id": 9458,
          "type_id": 9,
          "hour_buy_cost": 62.2,
          "hour_sell_cost": 100,
          "day_buy_cost": 560,
          "day_sell_cost": 1000,
          "week_buy_cost": 1000,
          "week_sell_cost": 3500,
          "date_start": "2023-01-01",
          "date_end": "2023-12-31",
          "taxes": [
            {
              "id": 3247,
              "name": "GST",
              "rate": "10.00",
              "total": "151.00"
            }
          ],
          "currency": "AUD"
        }
      ],
      "color_background": "#B0A7F1",
      "color_text": "#000000",
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "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 Resources

Authorizations

Query Parameters

Response