Skip to main content
GET
List work assignments

Authorizations

Authorization
string
header
required

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

Query Parameters

business_entity_id
string
pay_schedule_id
string
employee_id
string
contractor_id
string
payee_type
enum<string>

Filter results by payee type.

Available options:
contractor,
employee
search_payee_names
string
external_ref
string
tag_id
string
tag_group_id
string
include_archived
boolean
archived_at
object

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
enum<string>

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).

Available options:
payee.default,
payee.first_name,
payee.last_name
expand
enum<string>[]
Available options:
business_entity,
contractor,
effective_tax_properties,
employee,
pay_rates,
pay_schedule,
pay_split,
remittance_accounts,
tag_assignment,
tax_properties

Response

200 - application/json

OK

object
string
read-only

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

data
object[]