---
title: List all business units with filtering
slug: reference/list-all-business-units-with-filtering
docTags: 
createdAt: 2025-07-03T16:20:35.016Z
---

{
  "id": "Jmc-NdHSo04XN2mQq6jfp",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://app.amberflo.io/business-unit/details",
    "servers": [
      {
        "url": "https://app.amberflo.io/business-unit/details"
      }
    ],
    "name": "List all business units with filtering",
    "description": "<p>Retrieves paginated list of business units configured in your organization for cost allocation and resource management.\nBusiness units enable cost tracking, budget assignment, and organizational reporting across cloud resources.</p>\n<p>Required parameters:</p>\n<ul>\n<li>None - returns all accessible business units</li>\n</ul>\n<p>Optional parameters:</p>\n<ul>\n<li><code>limit</code>: Controls pagination page size for large organizations</li>\n<li><code>page</code>: Specifies which page of results to return</li>\n<li><code>isAscending</code>: Controls sort direction for business unit ordering</li>\n<li><code>sort</code>: Specifies field to sort results by (name, id, createTime, etc.)</li>\n<li><code>search</code>: Full-text search across business unit names, IDs, and descriptions</li>\n<li><code>idList</code>: Retrieves specific business units by ID list (bypasses other filters)</li>\n</ul>\n<p>Returns paginated business unit data including contact information, creation timestamps, and organizational metadata.\nUse search and filtering to find relevant business units in large enterprise deployments.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "limit",
          "type": "integer<int32>",
          "description": "Maximum number of business unit records to return per page. Controls pagination size for efficient data retrieval."
        },
        {
          "kind": "optional",
          "name": "page",
          "type": "integer<int32>",
          "description": "<p>Zero-based page number for pagination navigation. Used with limit parameter to access business unit result pages.</p>"
        },
        {
          "kind": "optional",
          "name": "isAscending",
          "type": "boolean",
          "description": "<p>Sort direction flag for business unit ordering. True for ascending alphabetical order, false for descending by selected field.</p>"
        },
        {
          "kind": "optional",
          "name": "sort",
          "type": "string",
          "description": "<p>Field name to sort business unit results by. Supports name, id, createTimeInMillis, updateTimeInMillis for organizational ordering.</p>"
        },
        {
          "kind": "optional",
          "name": "search",
          "type": "string",
          "description": "<p>Full-text search query across business unit names, identifiers, and descriptions. Enables rapid discovery in large organizations.</p>"
        },
        {
          "kind": "optional",
          "name": "idList",
          "type": "array",
          "description": "Comma-separated list of specific business unit identifiers to retrieve. When provided, overrides pagination and filtering parameters.",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKey",
          "name": "X-API-KEY",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Successful request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "business_unit.details.paging.BusinessUnitPagingResponse.out",
            "schema": [
              {
                "name": "metadata",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/business_unit.details.paging.BusinessUnitPagingMetadata.out",
                "customType": "business_unit.details.paging.BusinessUnitPagingMetadata.out",
                "schema": [
                  {
                    "name": "limit",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "example": 0
                  },
                  {
                    "name": "page",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "example": 0
                  },
                  {
                    "name": "isAscending",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "",
                    "example": ""
                  },
                  {
                    "name": "sort",
                    "kind": "optional",
                    "type": "string",
                    "description": "",
                    "example": ""
                  },
                  {
                    "name": "search",
                    "kind": "optional",
                    "type": "string",
                    "description": "Filter business unit by searching for the provided string in `name`, `id`, and `description`.",
                    "example": ""
                  },
                  {
                    "name": "idList",
                    "kind": "optional",
                    "type": "array",
                    "description": "Comma separated list of business unit's `id`s to retrieve.\n\nWhen providing this parameter, the others are ignored.\n",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "totalRowCount",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "example": 0
                  },
                  {
                    "name": "filteredRowCount",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "example": 0
                  },
                  {
                    "name": "totalFilteredPages",
                    "kind": "optional",
                    "type": "integer<int32>",
                    "description": "",
                    "example": 0
                  }
                ]
              },
              {
                "name": "items",
                "kind": "optional",
                "type": "array",
                "description": "Complete business unit configuration with system audit timestamps. Represents organizational entities for cloud cost allocation, budget control, and departmental spending tracking within FOCUS-compliant cost management systems.",
                "modelRef": "#/components/schemas/business_unit.details.BusinessUnit.out",
                "customType": "business_unit.details.BusinessUnit.out[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string",
                    "description": "Unique business unit identifier for cost allocation and organizational tracking. Used in FOCUS data ingestion and chargeback calculations across cloud resources.",
                    "example": ""
                  },
                  {
                    "name": "name",
                    "kind": "required",
                    "type": "string",
                    "description": "Human-readable business unit display name shown in management interfaces and cost reports. Required for user identification and organizational hierarchy navigation.",
                    "example": ""
                  },
                  {
                    "name": "description",
                    "kind": "optional",
                    "type": "string",
                    "description": "Optional detailed description explaining business unit purpose, scope, and organizational context for cost allocation and budget management activities.",
                    "example": ""
                  },
                  {
                    "name": "contacts",
                    "kind": "optional",
                    "type": "array",
                    "description": "Contact information array for business unit owners and managers responsible for cost oversight and budget approvals.",
                    "modelRef": "#/components/schemas/business_unit.details.BusinessUnitContact.out",
                    "customType": "business_unit.details.BusinessUnitContact.out[]",
                    "schema": [
                      {
                        "name": "email",
                        "kind": "required",
                        "type": "string",
                        "description": "Business unit contact email address for cost notifications and budget alerts. Used for automated reporting and budget threshold communications.",
                        "example": ""
                      },
                      {
                        "name": "name",
                        "kind": "required",
                        "type": "string",
                        "description": "Full name of business unit contact person responsible for cost oversight and budget management decisions within the organizational structure.",
                        "example": ""
                      }
                    ]
                  },
                  {
                    "name": "createTimeInMillis",
                    "kind": "optional",
                    "type": "integer<int64>",
                    "description": "Business unit creation timestamp in Unix milliseconds. System-generated when business unit configuration is first registered in cost management system.",
                    "example": 0
                  },
                  {
                    "name": "updateTimeInMillis",
                    "kind": "optional",
                    "type": "integer<int64>",
                    "description": "Last modification timestamp in Unix milliseconds. Updated automatically whenever business unit configuration details are changed through management interfaces.",
                    "example": 0
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/business_unit.details.paging.BusinessUnitPagingResponse.out",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "N-Zdns0q15QdycbO2OAFx",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://app.amberflo.io/business-unit/details \\\n     --header 'accept: application/json'"
        },
        {
          "id": "6q2_r59TezeN0U5atwr3V",
          "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://app.amberflo.io/business-unit/details\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "J0ZB7PC70aIhfEcjuelcY",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/business-unit/details\")\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": "G_r5y54uvDps0rwBM6mOW",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/business-unit/details\"\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": "N-Zdns0q15QdycbO2OAFx"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Successful request\n{\n  \"metadata\": {\n    \"limit\": \"\",\n    \"page\": \"\",\n    \"isAscending\": false,\n    \"sort\": \"\",\n    \"search\": \"\",\n    \"idList\": [\n      \"\"\n    ],\n    \"totalRowCount\": \"\",\n    \"filteredRowCount\": \"\",\n    \"totalFilteredPages\": \"\"\n  },\n  \"items\": [\n    {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"description\": \"\",\n      \"contacts\": [\n        {\n          \"email\": \"\",\n          \"name\": \"\"\n        }\n      ],\n      \"createTimeInMillis\": \"\",\n      \"updateTimeInMillis\": \"\"\n    }\n  ]\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": "",
      "id": "lSTUglHGRgUzlM0gcYNKT"
    }
  ]
}