List Appointment Schedules

GET /api/appointment_schedule

Retrieve a paginated list of appointment schedules. Supports filtering by organization, date range, status, and full-text search. Results are limited to the last 14 days by default.

Note: Always provide an organization_uuid to scope the results. If omitted, it falls back to your user's default organization, which may return unexpected results.

Query Parameters

Parameter	Type	Required	Description
`organization_uuid`	string	Yes	UUID of the organization (recommended — falls back to user's org if omitted)
`status`	string	No	Filter by appointment status
`service_uuid`	string	No	Filter by service UUID
`qr_code_uuid`	string	No	Filter by QR code address UUID
`qr_code_tag_uuid`	string	No	Filter by QR code tag UUID
`job_reference_id`	string	No	Filter by job reference ID
`from_date`	string	No	Start date (YYYY-MM-DD). Defaults to 14 days ago.
`to_date`	string	No	End date (YYYY-MM-DD)
`search`	string	No	Full-text search across location and tags
`page`	integer	No	Page number (default: `1`)
`per_page`	integer	No	Items per page (default: `20`)
`order`	string	No	Sort direction: `asc` or `desc`
`order_by`	string	No	Field to sort by
`pagination`	boolean	No	Enable paginated response (default: `false`)

14-Day Lookback

The endpoint automatically filters to appointment schedules from the last 14 days (based on start_date_time). Use from_date to override the window.

See Errors & Rate Limits for the common error contract used across the API.

Error Codes

Status	Meaning
400	Bad Request
401	Unauthorized
500	Internal Server Error

Example Request

curl

curl -H "Authorization: Bearer your_api_key:your_api_secret" \
  "http://staging.didyougo.com.au/api/appointment_schedule?organization_uuid=org-uuid&status=scheduled&page=1&per_page=20"

Try It

Try it

Authorization Required

Requests are sent without cookies — you must provide a valid Bearer <api_key>:<api_secret> header.

Query Parameters

API Response

Click the Send API Request button above and see the response here!

Example Response

json

[
  {
    "uuid": "XYZ789UVW123RST456MNOP",
    "organization_uuid": "org-uuid",
    "job_reference_id": "JOB-001",
    "appointment_date": "2025-01-15",
    "start_date_time": "2025-01-15T09:00:00Z",
    "duration": 60,
    "status": "scheduled",
    "service_uuid": "svc-uuid",
    "qr_code_uuid": "ABC123DEF456GHI789JKLM",
    "qr_code_tag_uuid": null,
    "created_on": "2025-01-10T10:30:00Z",
    "updated_on": "2025-01-10T10:30:00Z"
  }
]

Paginated Response

When pagination=true, the response wraps in:

json

{
  "items": [...],
  "first": 1,
  "last": 1,
  "total": 1,
  "pages": 1,
  "page": 1,
  "per_page": 20
}