Skip to main content
GET
List primary appointments

Authorizations

Authorization
string
header
required

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

Headers

Authorization
string
required

Bearer token

Query Parameters

include
string

Comma-separated list of relationships to include. Allowed: profile, rank, department, campus

sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at

filter[key]
string

Filter results. Available filters: is_current (boolean, Limit to currently-effective records.), title, title.neq, title.cont (case-insensitive substring match), title.in (comma-separated list), title.nin (comma-separated list), effective_from, effective_from.neq, effective_from.lt, effective_from.lte, effective_from.gt, effective_from.gte, track_type, track_type.neq, track_type.cont (case-insensitive substring match), track_type.in (comma-separated list), track_type.nin (comma-separated list), external_id, external_id.neq, external_id.cont (case-insensitive substring match), external_id.in (comma-separated list), external_id.nin (comma-separated list), effective_to, effective_to.neq, effective_to.lt, effective_to.lte, effective_to.gt (null values are treated as unbounded above and match this filter), effective_to.gte (null values are treated as unbounded above and match this filter), terminated_on, terminated_on.neq, terminated_on.lt, terminated_on.lte, terminated_on.gt, terminated_on.gte, percent_allocation (number), percent_allocation.neq (number), percent_allocation.lt (number), percent_allocation.lte (number), percent_allocation.gt (number), percent_allocation.gte (number), percent_allocation.in (number, comma-separated list), percent_allocation.nin (number, comma-separated list), appointment_type, appointment_type.neq, appointment_type.cont (case-insensitive substring match), appointment_type.in (comma-separated list), appointment_type.nin (comma-separated list), full_time (boolean), profile, rank, department, campus, campus.exists. Custom fields can also be filtered with filter[custom_fields.field_name].

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

primary appointments found

data
object[]
required
meta
object