---
title: "List custom parameters"
type: reference
method: GET
path: /rest-api/custom-parameters.do
tag: "Custom Parameters"
---

# List custom parameters

`GET https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameters.do`

The parameters registered for the network's ad tags. Targeting editors offer them as the parameter of a Custom Parameter rule. usage=true adds rules: how many Custom Parameter targeting rules on live entities read each one, and unregistered: the names such rules read that are not registered, with their rule counts. Both, and the description, come back only to callers with the CUSTOM_PARAMETERS admin permission: the rules are read from other clients' targeting, and the description is the admins' own note. policy says what reaches analytics: LEGACY (the Analytics configuration list still decides; legacy describes it to CUSTOM_PARAMETERS admins), ANY (every parameter except those with recordInAnalytics false) or ONLY_VERIFIED (only registered parameters with recordInAnalytics true). Fields: id, name (without the cp. prefix), label, description, valueMode (DYNAMIC: any value; STATIC: one of values), allowOtherValues, values ([{value, label}] in list order), listSeparator (COMMA, PIPE, SEMICOLON, WHITESPACE, their ids 1 to 4, or null: the character a request value carrying several values is split on before a One of rule matches it item by item), recordInAnalytics, builtIn (seeded with the platform: kept by name, never deleted), canBeRemoved, createdAt, updatedAt.

## Query params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `usage` | boolean | no | `true` | true: count the targeting rules that read each parameter (CUSTOM_PARAMETERS admins only) |
| `query` | string | no | `genre` | Only the parameters whose name or label contains this, ignoring case |

## Responses

- `200` — {parameters: [parameter], total, mayManage (whether the caller may change them and see the rules that read them), policy (LEGACY, ANY or ONLY_VERIFIED), legacy: {names, mode, applies (the list's filter is on for this server; other servers may differ), movesByItself (the list is empty, so the policy leaves LEGACY within a minute)} while LEGACY (CUSTOM_PARAMETERS admins only), unregistered: [{name, rules}] with usage=true}
- `400` — Bad request — invalid or missing parameters
- `401` — Authentication error
- `403` — Forbidden — insufficient permissions

## Example request

```bash
curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/custom-parameters.do?usage=true&query=genre' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Source: https://epom.com/ad-server/docs/api/custom-parameters/get-custom-parameters