---
title: "Get Sub-Affiliate List"
method: POST
path: "/v4/affiliates/reports"
tags: ["Gateway Features", "Affiliates"]
---

# Get Sub-Affiliate List

`POST /v4/affiliates/reports`

## Request

- Base URL: `https://sandbox.nmi.com/api`
- URL: `https://sandbox.nmi.com/api/v4/affiliates/reports`
- Auth: none required

<details>
<summary>Usage</summary>
This is a query to get all sub-affiliate accounts under your partner account.
</details>

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- GetSubAffiliatesListRequest
  - `maxResults` string, required: Number of max results, any integer number from 1 to 1000.
  - `ids` string[]: An array of merchant ids.
  - `parentAffiliateId` string: An affiliate id. Only merchants under this affiliate will be returned, rather than the full tree.
  - `search` string: Performs a search on this text as a case-insensitive search on any of the following: email, company name, first and last name, phone number, external id, or username.
  - `offset` string: Like all reports and search endpoints, you can specify the offset, which is the start point for the responses.

## Response `200`

Success

- GetSubAffiliatesListResponse
  - `objectType` string: Type of the object, in this case, 'report'.
  - `reportId` integer: ID for the report.
  - `offset` integer, nullable: Offset value for pagination, or null if not used.
  - `maxResults` integer: Maximum number of results per page.
  - `totalResults` integer: Total number of results available for the report.
  - `hasMore` boolean: Indicates if there are more results available beyond the current page.
  - `links` object: Pagination links for navigating through the report results.
    - `first` string, uri: URL to the first page of results.
    - `last` string, uri: URL to the last page of results.
    - `next` string, uri: URL to the next page of results.
    - `previous` string, uri: URL to the previous page of results.
  - `results` object[]: List of sub-affiliate details.
    - `objectType` string: Type of the object, typically 'affiliate' for sub-affiliate details.
    - `id` string: ID for the sub-affiliate.
    - `firstName` string: First name of the sub-affiliate.
    - `lastName` string: Last name of the sub-affiliate.
    - `company` string: Company name of the sub-affiliate.
    - `email` string, email: Email address of the sub-affiliate.
    - `replyToEmail` string, email, nullable: Reply-to email address for the sub-affiliate.
    - `camAssignedName` string, nullable: Name of the Customer Account Manager (CAM) assigned to the sub-affiliate. CAMs are assigned on top-level partner accounts, so this is null for a sub-affiliate with no CRM account of its own; read the CAM from its parent affiliate in that case.
    - `phone` string: Phone number of the sub-affiliate.
    - `fax` string, nullable: Fax number of the sub-affiliate.
    - `url` string, uri, nullable: Website URL of the sub-affiliate.
    - `address1` string: Primary address line for the sub-affiliate.
    - `address2` string, nullable: Secondary address line for the sub-affiliate.
    - `city` string: City of the sub-affiliate's address.
    - `state` string: State or region of the sub-affiliate's address.
    - `zip` string: Postal or ZIP code of the sub-affiliate's address.
    - `country` string: Country code of the sub-affiliate's address (ISO 3166-1 alpha-2).
    - `timezone` string: Time zone of the sub-affiliate.
    - `features` object: Set of features available to the sub-affiliate.
      - `allowCredits` boolean: Indicates if the sub-affiliate is allowed to issue credits.
      - `canOfferCashDiscount` boolean: Indicates if the sub-affiliate can offer cash discounts.
    - `status` string: Current status of the sub-affiliate (e.g., active, inactive).
    - `created` string, date-time: Timestamp when the sub-affiliate was created.
    - `updated` string, date-time: Timestamp when the sub-affiliate was last updated.
    - `parentAffiliateId` string: ID for the parent affiliate of the sub-affiliate.
    - `support` object: Contact details for various support roles within the sub-affiliate's organization.
      - `general` object: General support contact details.
        - `email` string, email: Email address for general support.
        - `phone` string: Phone number for general support.
        - `name` string: Name of the general support contact.
      - `check` object: Check support contact details.
        - `email` string, email, nullable: Email address for check support.
        - `phone` string, nullable: Phone number for check support.
        - `name` string, nullable: Name of the check support contact.
      - `accounting` object: Accounting support contact details.
        - `email` string, email, nullable: Email address for accounting support.
        - `phone` string, nullable: Phone number for accounting support.
        - `name` string, nullable: Name of the accounting support contact.
      - `riskManagement` object: Risk management support contact details.
        - `email` string, email, nullable: Email address for risk management support.
        - `phone` string, nullable: Phone number for risk management support.
        - `name` string, nullable: Name of the risk management support contact.
      - `accountManagement` object: Account management support contact details.
        - `email` string, email, nullable: Email address for account management support.
        - `phone` string, nullable: Phone number for account management support.
        - `name` string, nullable: Name of the account management support contact.
      - `marketing` object: Marketing support contact details.
        - `email` string, email, nullable: Email address for marketing support.
        - `phone` string, nullable: Phone number for marketing support.
        - `name` string, nullable: Name of the marketing support contact.
      - `technical` object: Technical support contact details.
        - `email` string, email, nullable: Email address for technical support.
        - `phone` string, nullable: Phone number for technical support.
        - `name` string, nullable: Name of the technical support contact.
      - `emergency` object: Emergency support contact details.
        - `email` string, email, nullable: Email address for emergency support.
        - `phone` string, nullable: Phone number for emergency support.
        - `name` string, nullable: Name of the emergency support contact.
    - `branding` object: Branding information for the sub-affiliate.
      - `gatewayTitle` string: Title or name of the gateway as branded by the sub-affiliate.
      - `isBranded` boolean: Indicates if the gateway is branded for the sub-affiliate.
    - `accountInfo` object: Account information for the sub-affiliate.
      - `checkAba` string: ABA routing number for check transactions.
      - `checkAccount` string: Masked account number for check transactions.
      - `legalName` string: Legal name of the sub-affiliate's business.
      - `businessType` string: Type of business entity (e.g., LLC, Corporation).
      - `taxId` string: Tax identification number, partially masked.
    - `billTo` string: Billing arrangement for the sub-affiliate (e.g., 'merchant').
    - `rejectedCertificates` string: Number of rejected certificates associated with the sub-affiliate.

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)