---
title: "Location add-on count"
method: GET
path: "/locations/add-on-count"
tags: ["Locations"]
---

# Location add-on count

`GET /locations/add-on-count`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/add-on-count`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/add-on-count/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns how many locations in the filtered set have the specified add-on enabled vs disabled, along with counts for other add-ons in the same product umbrella. Scope the set with `filterInput`/`selectionType`/`locationIds`, identical to Filter locations.

## Query parameters

- `addOnId` string, required
- `filterInput` string
- `selectionType` 'ALL_ITEMS' | 'SELECTED_ITEMS'
- `locationIds` string[]

## Headers

- `Synup-Version` string, required
- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `locationAddOnCount` LocationAddOnCount
      - `enabled` integer: Locations with the add-on enabled.
      - `disabled` integer: Locations with the add-on disabled.
      - `othersEnabled` AddOnCountV2[]: Counts for other add-ons in the same product umbrella.
        - `id` string
        - `name` string
        - `count` integer

## Other responses

- `401`: Unauthorized - Invalid or missing API key

---

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