Get All Guide Assignments in Date Range

get

https://app.workramp.com/api/v1/assignments/guide

If guide_id is not provided it will return all Guide assignments created or updated within the date range.
Assignments are returned in the same format as Course/Guide Assignment webhooks. Keys are snake_case (for example displayTitle → display_title), and the webhook-only eventType and timestamp fields are not included.
user is in the format defined in The user object.

❗️
You must provide either start_time (and optionally end_time) or due_date.

Deleting an assignment updates its updated_at, so incremental syncs with include_deleted=true pick up deletions.

Query Params

start_time

date-time

Returns assignments created or updated at or after this time. The bound is inclusive, so an assignment updated at exactly start_time is returned. Accepts an ISO 8601 date or datetime. A datetime with no UTC offset is read as UTC, and a date with no time means midnight UTC.

end_time

date-time

Returns assignments created or updated at or before this time. The bound is inclusive, so an assignment updated at exactly end_time is returned. Accepts the same formats as start_time. Leave it out to return everything from start_time onwards.

due_date

date

Returns assignments due on this date, for example 2025-06-01. We store due dates in UTC and compare by UTC calendar day, so 2025-06-01 covers 00:00:00 to 23:59:59 UTC (both inclusive) on 1 June. The due date values in responses are also UTC. Read the date part as the due date and don't convert it to a local timezone, because that can move it to the previous or next day. The API ignores due_date if you also send start_time.

guide_id

string

A specific guide to limit the results to. - If guide_id is not provided it will return all Guide assignments created or updated within the date range.

include_deleted

boolean

Defaults to false

Optional - if you want to also retrieve assignments which have been deleted, pass true. Use guide_assignment.is_deleted (true when deleted) in the response to detect these.

page

int32

Defaults to 1

Page of results to return

per_page

int32

Defaults to 20

Number of results to return per page (1-200)

Responses

Get All Guide Assignments in Date Range

You must provide either `start_time` (and optionally `end_time`) or `due_date`.

Deleting an assignment updates its `updated_at`, so incremental syncs with `include_deleted=true` pick up deletions.

You must provide either start_time (and optionally end_time) or due_date.

Deleting an assignment updates its updated_at, so incremental syncs with include_deleted=true pick up deletions.

200200

400400

You must provide either `start_time` (and optionally `end_time`) or `due_date`.

Deleting an assignment updates its `updated_at`, so incremental syncs with `include_deleted=true` pick up deletions.