Skip to main content
POST
Search work assignments

Authorizations

Authorization
string
header
required

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

Body

application/json
business_entity_id
string
required

The business entity whose work assignments to search.

work_assignments
object
required

The selection criteria.

work_assignments.include must be either the string "all", or an object containing one or more of ids (string array), payee_type (employee or contractor), pay_schedule_id, archived (boolean).

work_assignments.exclude (optional) is an object containing one or more of the same keys.

Response

200 - application/json

OK

object
string
read-only

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

data
object[]