Get All Guide Assignments in Date Range
Request
- Base URLhttps://app.workramp.com
- URLhttps://app.workramp.com/api/v1/assignments/guide
- AuthAPI key in header Authorization
Query parameters
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.
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.
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.
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.
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 of results to return
Number of results to return per page (1-200)
Response
200
Example response
{
"has_more": true,
"item_count": 29,
"page": 1,
"per_page": 20,
"url": "/api/v1/assignments/guide",
"data": {
"assignments": [
{
"guide": {
"id": "0194fb51-cc67-7c03-b14e-fd744ab2ce2a",
"displayTitle": "Test Guide"
}
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.