List contractors

Authorizations

Authorization

string

header

required

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

Query Parameters

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

external_ref

string

search_names

string

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:

business_name,

first_name,

last_name

has_work_assignment_business_entity_id

string

has_work_assignment_pay_schedule_id

string

include_archived_work_assignments

boolean

tag_id

string

expand

enum<string>[]

Available options:

company,

work_assignments

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Default · object

Default
With company expanded
With work_assignments expanded

Hide child attributes

data.data.business_name

string | null

The contractor's business or corporation name. null for individual contractors.

Maximum string length: 255

data.data.first_name

string | null

The contractor's first name. null for corporation contractors.

Maximum string length: 50

data.data.last_name

string | null

The contractor's last name. null for corporation contractors.

Maximum string length: 50

data.data.middle_initial

string | null

The contractor's middle initial. null for corporation contractors.

Maximum string length: 1

data.data.email

string | null

The contractor's email address, used for payroll communications.

Maximum string length: 255

data.data.business_number

string | null

The contractor's 15-character (BN15) Canada Revenue Agency (CRA) program account number, consisting of a 9-digit Business Number (BN), a 2-letter program identifier, and a 4-digit reference number. null for individual contractors.

Maximum string length: 15

data.data.sin_last_3

any

The last 3 digits of the contractor's Social Insurance Number (SIN). null if no SIN has been provided.

data.data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.data.preferred_locale

enum<string> | null

The locale used for payroll communications sent to this contractor, such as Pay Stub emails. If not set, the Business Entity's locale is used.

Available options:

en,

fr

data.data.archived_at

string<dateTime> | null

read-only

The date the contractor was archived. Archiving a contractor also archives all Work Assignments that are not already archived. Archived contractors do not appear in active listings.

data.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.