# Get system-defined flags for a listing.

`GET /listings/{listing_id}/flags`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-flags · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetFlags` · Tag: Listing Flags

Returns system-managed flags (as opposed to user-defined tags) associated with the listing.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/flags`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Read-only keys can call this endpoint.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `listing_id` | string | yes | The channel's unique listing identifier, or the Wheelhouse listing ID when `channel` is `wheelhouse`. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `channel` | string | yes | Channel name the listing is on (the `channel` field of the [/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-listings.md) response), or the literal `wheelhouse` to read `listing_id` as a Wheelhouse listing ID instead. See [Identifying Listings](https://docs.usewheelhouse.com/rm/concepts/listings.md). |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/flags?channel=<channel>' \
  -H 'X-Integration-Api-Key: <your RM API key>'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 200

Array of flags.

Body (`application/json`): array of object

- `category` (string, nullable, one of: `engine`, `info`, `performance`, `settings`): What the flag means for the listing's pricing:

  * `engine` — a setup that keeps Wheelhouse from pricing the listing as recommended, such as fixed prices, a minimum price above the base price, or a maximum price below the minimum.
  * `info` — context about the listing, such as being new to Wheelhouse or having its recommended base price lowered by its booking history.
  * `performance` — how the listing is booking, such as pacing ahead of or behind last year, or going unbooked.
  * `settings` — a pricing setting worth reviewing because it is missing, set unusually high or low, or combined with another setting so that their effects compound or cancel out.

  `null` for an older flag that Wheelhouse no longer raises. New flags can be added to any category, so decide how to treat a flag from its `category` rather than from a list of flag names.
- `description` (string): An optional description of the flag.
- `name` (string): The flag name.

Example shape (generated from the schema; placeholder values, not a real response):

```json
[
  {
    "category": "engine",
    "description": "string",
    "name": "string"
  }
]
```

### 401

API key authorization failed.

### 403

Listing authorization failed.

### 404

Listing not found.

### 406

The listing is inactive. See the **Inactive Listings** section in the overview.

Body (`application/json`): object

- `error` (string, example: `Listing '12345' is inactive`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "Listing '12345' is inactive"
}
```

### 429

Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the **Rate Limits** section in the overview for the recommended exponential backoff strategy.

Body (`application/json`): object

- `error` (string, example: `API token is at rate limit`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "API token is at rate limit"
}
```
