---
title: "List contractors"
method: GET
path: "/contractors"
tags: ["Contractors"]
---

# List contractors

`GET /contractors`

## Query parameters

- `include_archived` boolean
- `archived_at` object
- `external_ref` string
- `search_names` string
- `sort` '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
- `tag_group_id` string
- `expand` string[]

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"contractor"`).
    - `data` Contractor
      - `business_name` string, nullable — The contractor's business or corporation name. `null` for individual contractors.
      - `first_name` string, nullable — The contractor's first name. `null` for corporation contractors.
      - `last_name` string, nullable — The contractor's last name. `null` for corporation contractors.
      - `middle_initial` string, nullable — The contractor's middle initial. `null` for corporation contractors.
      - `email` string, nullable — The contractor's email address, used for payroll communications.
      - `business_number` string, nullable — 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.
      - `sin_last_3` unknown
      - `external_ref` string, nullable — 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.
      - `preferred_locale` 'en' | 'fr', nullable — 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.
      - `archived_at` string, dateTime, nullable — 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.
      - `created_at` string, dateTime — The date and time the object was created in Nmbr.
      - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/revisions/01cd9c45a923/schema)