RosterList appointments

List appointments

Needs: Roster, Read

Lists appointments ordered by id. These original endpoints return a flat record, so use the shift endpoints for rich detail.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/appointments?per_page=25&page=25&updated_since=example_string&from=example_string&to=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": 55,
      "appointment_title": "Morning support",
      "client_id": 12,
      "employee_id": 31,
      "start": "2026-03-02 09:00:00",
      "end": "2026-03-02 13:00:00",
      "appointment_address": "1 Example St, Perth WA 6000",
      "is_draft": 1,
      "appointment_cancelled": 0,
      "is_deleted": 0,
      "created_at": "2026-02-20T01:00:00.000000Z",
      "updated_at": "2026-02-20T01:00:00.000000Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 1,
    "last_page": 1
  }
}
GET
/appointments
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
query
per_pageinteger

1 to 100. Defaults to 50.

query
pageinteger

Page number, 1 or greater.

query
updated_sincestring

A date. Only appointments updated on or after it.

query
fromstring

A date. Only appointments ending on or after it.

query
tostring

A date on or after from. Only appointments starting on or before it.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Query Parameters

per_pageinteger

1 to 100. Defaults to 50.

pageinteger

Page number, 1 or greater.

updated_sincestring

A date. Only appointments updated on or after it.

fromstring

A date. Only appointments ending on or after it.

tostring

A date on or after from. Only appointments starting on or before it.

Responses

OK