Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Work Assignments

List work assignments

get/work_assignments

Query parameters

business_entity_idstring
pay_schedule_idstring
employee_idstring
contractor_idstring
payee_type'contractor' | 'employee'

Filter results by payee type.

search_payee_namesstring
external_refstring
tag_idstring
tag_group_idstring
include_archivedboolean
archived_atobject

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: archived_at=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: archived_at[gte]=2024-01-01&archived_at[lt]=2024-12-31
sort'payee.default' | 'payee.first_name' | 'payee.last_name'

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

expandstring[]

Response

OK

objectstring

The type of the object in Nmbr ("list").