GET
/
v2
/
booking
curl --request GET \
  --url https://api.sonderplan.com/v2/booking \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "name": "Test Booking",
      "start": 1547501100,
      "end": 1547538900,
      "start_date_time_iso": "2022-02-22T09:00:00+11:00",
      "end_date_time_iso": "2022-02-22T17:00:00+11:00",
      "duration_min": "480",
      "all_day": "false",
      "notes": "Additional note",
      "repeat_master": "true",
      "repeat_master_id": "0",
      "repeat_rule": "FREQ=daily;INTERVAL=2;REPENDTYPE=date;UNTIL=20220228T130000;",
      "resources": [
        {
          "id": 9458,
          "name": "Edit Suite 1",
          "description": "Sydney Office, Level 2",
          "type_id": 1,
          "type_person_id": 0,
          "updated": 1388552400,
          "parent_id": 99472,
          "parent_name": "Edit Suites",
          "icon": [
            {
              "id": 2342354,
              "name": "Avid_Icon",
              "size": 174285,
              "alias": "7e73ab25155974c230d09494548201b9f5056ef",
              "extension": "png",
              "mime_type": "image/png"
            }
          ],
          "rates": [
            {
              "rate_scheme_id": 984312,
              "rate_scheme_name": "Resource Rate",
              "currency": "AUD",
              "buy": {
                "unit": "hourly",
                "unit_amount": "20.65",
                "quantity": "2.4",
                "discount": "20.00%"
              },
              "sell": {
                "unit": "hourly",
                "unit_amount": "20.65",
                "quantity": "2.4",
                "discount": "20.00%"
              }
            }
          ],
          "time_entries": [
            {
              "id": 9879871,
              "name": "Colour Grading",
              "description": "Opening scenes completed",
              "start": 1547501100,
              "end": 1547538900
            }
          ]
        }
      ],
      "project": [
        {
          "id": 2342354,
          "name": "Andor S1 EP7 Annoucement",
          "code": "AND-S1-EP7",
          "description": "Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization.",
          "status_id": 1
        }
      ],
      "client": [
        {
          "id": 4,
          "uuid": "p4",
          "name": "Jane Someone",
          "type": "person",
          "email": "[email protected]",
          "contact_person": {
            "id": 2837,
            "name": "Fred Flintstone"
          }
        }
      ],
      "status": [
        {
          "id": 2,
          "name": "Second Hold",
          "description": "Has second priority if the first hold cancels",
          "notification": true
        }
      ],
      "billable_items": [
        {
          "id": 2342354,
          "name": "NAS Storage",
          "description": "Rented per TB, per month",
          "cost": "25.23",
          "buy_cost": "20",
          "currency": "AUD",
          "quantity": "4",
          "total": "100.92",
          "buy_total": "80",
          "billable_item_id": 897832,
          "taxes": [
            {
              "id": 3247,
              "name": "GST",
              "rate": "10.00",
              "total": "151.00"
            }
          ],
          "create_new": true
        }
      ],
      "custom_fields": [
        {
          "id": 7823,
          "name": "Type",
          "value": "Video Editing",
          "value_id": 8973,
          "update_key": "2_1_7823"
        }
      ],
      "created_id": 3,
      "created": 1388552400,
      "created_name": "John Smith",
      "updated_id": 3,
      "updated": 1388552400,
      "updated_name": "John Smith"
    }
  ],
  "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

​
id
string

One or more (comma seperated) IDs of booking's to retrieve

​
name
string

Perform a full text search for the booking name

​
resource_ids
string

Specify one or more resource ids and return only the bookings that have these as resources

​
where_in_resource
string
deprecated

Specify one or more resource ids and return only the bookings that have these as resources

​
project_id
string

Specify one or more project ids and return only the bookings are booked to thes projects

​
from_time
integer

Return any bookings starting after the given UNIX timestamp

​
to_time
integer

Return any bookings starting before the given UNIX timestamp

​
resource_icon
boolean

The resources object will contain icon information for each resource

​
resource_rates
boolean

The resources object will contain rates data for each resource relatd to the current booking

​
resource_parent
boolean

The resources object will contain the name of the parent of the resource

​
resource_ids_match_all
boolean

When set to true, only return bookings that include all the specified resource_ids. If false (default), bookings will be returned if they include any of the specified resource_ids.

​
resource_time_entries
boolean

When set to true, time entries will be output within each of the the relevant booking resource objects

​
updated_after
integer

Return results that were added, edited or deleted since this UNIX timestamp

​
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

The response is of type object.