---
title: "List pay splits"
method: GET
path: "/pay_splits"
tags: ["Pay Splits"]
---

# List pay splits

`GET /pay_splits`

## Query parameters

- `employee_id` string
- `contractor_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 (`"pay_split"`).
    - `data` PaySplit
      - `employee` object — The Employee who owns this pay split. Present only for Employee pay splits.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"employee"`).
      - `type` 'amount' | 'percentage' — The split strategy. `amount` sends fixed dollar amounts in priority order with the last configured Bank Account receiving the remaining balance. `percentage` distributes by percentage; percentage must total 100% across all accounts.
      - `title` string, nullable — A label for this pay split configuration.
      - `title_translations` Translations, nullable
        - `en` string
        - `fr` string
      - `title_translated` string — The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header.
      - `is_default` boolean — Whether this is the default pay split for the Employee or Contractor.
      - `priority_1_bank_account` object — The first priority Bank Account.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"bank_account"`).
        - `data` BankAccount
          - `business_entity` object — The Business Entity that owns this bank account. Present only for Business Entity bank accounts.
            - `id` string — The unique identifier of the object in Nmbr.
            - `object` string — The type of the object in Nmbr (`"business_entity"`).
          - `institution_number` string — The 3-digit bank institution number.
          - `institution_name` string, nullable — The name of the banking institution matching the institution number, or `null` if the number is not recognized. Always the English name; see `institution_name_translated` for the value in the request's locale.
          - `institution_name_translations` object, nullable
            - `en` string, nullable
            - `fr` string, nullable
          - `institution_name_translated` string — The translation of the `institution_name` property for the request locale. Computed using the values in `institution_name` and `institution_name_translations` and the value of the request's `Accept-Language` header.
          - `transit_number` string — The 5-digit bank transit number.
          - `transit_address` string, nullable — The address of the branch matching the institution and transit numbers, or `null` if the pair is not recognized.
          - `account_number_last_3` string, nullable — The last 3 digits of the bank account number.
          - `is_primary` boolean — Whether this is the primary bank account for its owner.
          - `is_deletable` boolean — Whether this bank account can be deleted.
          - `warnings` object, nullable — A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.
            - `object` string, nullable
            - `data` object, nullable
          - `is_pad_signed` boolean — Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.
          - `pad_signer_name` string, nullable — The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.
          - `pad_signer_email` string, nullable — The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.
          - `pad_signer_title` string, nullable — The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.
          - `pad_signed_at` string, dateTime, nullable — The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.
          - `pad_file` unknown
          - `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.
      - `priority_1_amount` number — The amount or percentage allocated to the first priority Bank Account.
      - `priority_2_bank_account` object — The second priority Bank Account.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"bank_account"`).
        - `data` BankAccount
          - `business_entity` object — The Business Entity that owns this bank account. Present only for Business Entity bank accounts.
            - `id` string — The unique identifier of the object in Nmbr.
            - `object` string — The type of the object in Nmbr (`"business_entity"`).
          - `institution_number` string — The 3-digit bank institution number.
          - `institution_name` string, nullable — The name of the banking institution matching the institution number, or `null` if the number is not recognized. Always the English name; see `institution_name_translated` for the value in the request's locale.
          - `institution_name_translations` object, nullable
            - `en` string, nullable
            - `fr` string, nullable
          - `institution_name_translated` string — The translation of the `institution_name` property for the request locale. Computed using the values in `institution_name` and `institution_name_translations` and the value of the request's `Accept-Language` header.
          - `transit_number` string — The 5-digit bank transit number.
          - `transit_address` string, nullable — The address of the branch matching the institution and transit numbers, or `null` if the pair is not recognized.
          - `account_number_last_3` string, nullable — The last 3 digits of the bank account number.
          - `is_primary` boolean — Whether this is the primary bank account for its owner.
          - `is_deletable` boolean — Whether this bank account can be deleted.
          - `warnings` object, nullable — A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.
            - `object` string, nullable
            - `data` object, nullable
          - `is_pad_signed` boolean — Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.
          - `pad_signer_name` string, nullable — The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.
          - `pad_signer_email` string, nullable — The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.
          - `pad_signer_title` string, nullable — The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.
          - `pad_signed_at` string, dateTime, nullable — The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.
          - `pad_file` unknown
          - `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.
      - `priority_2_amount` number, nullable — The amount or percentage for the second priority Bank Account. For `amount`-type splits, set to `null` if this is the last account (receives the remainder).
      - `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)