Get Sub-Affiliate List

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/nmi/json-schema/nmi-get-sub-affiliates-list-request-schema.json",
  "title": "Get Sub-Affiliate List",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/nmi-affiliates-api-openapi.yml#/components/schemas/GetSubAffiliatesListRequest",
  "allOf": [
    {
      "type": "object",
      "required": [
        "maxResults"
      ],
      "properties": {
        "maxResults": {
          "type": "string",
          "description": "Number of max results, any integer number from 1 to 1000."
        },
        "ids": {
          "type": "array",
          "description": "An array of merchant ids.",
          "items": {
            "type": "string"
          }
        },
        "parentAffiliateId": {
          "type": "string",
          "description": "An affiliate id. Only merchants under this affiliate will be returned, rather than the full tree."
        },
        "search": {
          "type": "string",
          "description": "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": {
          "type": "string",
          "description": "Like all reports and search endpoints, you can specify the offset, which is the start point for the responses."
        }
      }
    }
  ]
}