---
title: Retrieve sub-customers.
slug: fx-api/retrieve-sub-customers
docTags: 
createdAt: 2026-02-25T00:52:10.247Z
---

{
  "id": "NMfNyDcZ_FxuQck1alonJ",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://sand-api.monoova.com/global/v1/sub_customers",
    "servers": [
      {
        "url": "https://sand-api.monoova.com/global/v1/sub_customers",
        "description": "Monoova Global server"
      }
    ],
    "name": "Retrieve sub-customers.",
    "description": "<p>This retrieves all sub-customers for the customer. Archived sub-customers are hidden by default, but can be retrieved by filtering on status.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "status",
          "type": "object",
          "description": "<p>Filter sub-customers by status</p>",
          "customType": "SubCustomerStatus",
          "schema": [],
          "modelRef": "#/components/schemas/SubCustomerStatus"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "<p>A list of sub-customers.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "sub_customers",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/SubCustomerResponse",
                "customType": "SubCustomerResponse[]",
                "schema": []
              },
              {
                "name": "pagination",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/Pagination",
                "customType": "Pagination",
                "schema": []
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "6g17Xx75pp1QaSeWsbYO-",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url 'https://sand-api.monoova.com/global/v1/sub_customers?status=object' \\\n     --header 'accept: application/json'"
        },
        {
          "id": "62BAMvtKltNGFOGd0oRxK",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/global/v1/sub_customers?status=object\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "T8l3GabKu5FbtYg945lrY",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/global/v1/sub_customers?status=object\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "70CKQH9m6_cOqwmT0ISjI",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/global/v1/sub_customers?status=object\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "6g17Xx75pp1QaSeWsbYO-"
    },
    "results": {
      "languages": [
        {
          "id": "MkTA-lPTVnlpNpTtmPMw4",
          "language": "200",
          "code": "// A list of sub-customers.\n{\n  \"sub_customers\": [\n    \"\"\n  ],\n  \"pagination\": {}\n}"
        }
      ],
      "selectedLanguageId": "MkTA-lPTVnlpNpTtmPMw4"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}