API Reference

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.
  • user is in the format defined in The user object

See also Get All SCORM Assignments in Date Range and Get All Path Assignments in Date Range.

❗️

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

📘

When due_date is provided assignments will be filtered based on the due date being in a 24 hour range starting at due_date. You can pass a full ISO8601 string if you would like a day within a specific timezone, eg "2025-06-01T00:00:00-07:00".

Query Params
string

The minimum created/updated timestamp. This should be an ISO 8601 date/time.

string

The maximum created/updated timestamp. This should be an ISO8601 date/time.

string

ISO8601 date or datetime to filter on assignment due date

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.

boolean
Defaults to false

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

int32
Defaults to 1

Page of results to return

int32
Defaults to 20

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

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago

Did this page help you?