---
title: "Labels API endpoints"
description: "Endpoint reference for the Labels tag (8 endpoints): Labels attached to campaigns, banners and placements"
type: "reference"
audience: [network-manager, admin]
keywords: [api, rest, endpoints, labels]
---

Fetch the complete documentation index at: https://epom.com/ad-server/docs/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Labels API endpoints

Labels attached to campaigns, banners and placements. 8 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see [REST API overview](https://epom.com/ad-server/docs/api.md). Parameters marked `form` go in an `application/x-www-form-urlencoded` request body.

### GET /rest-api/label/{labelId}.do

[Request examples](https://epom.com/ad-server/docs/api/labels/get-label.md)

Get label by ID.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `labelId` | path | integer | yes | Unique numeric identifier of the label to retrieve |

**Responses:** `200` — Label retrieved successfully · `404` — Label not found. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### DELETE /rest-api/label/{labelId}/delete.do

[Request examples](https://epom.com/ad-server/docs/api/labels/delete-label.md)

Delete a label.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `labelId` | path | integer | yes | Unique numeric identifier of the label to delete |

**Responses:** `200` — Label deleted successfully · `404` — Label not found. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/label/{labelId}/update.do

[Request examples](https://epom.com/ad-server/docs/api/labels/post-label-update.md)

Update an existing label.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `labelId` | path | integer | yes | Unique numeric identifier of the label to update |

**Request body** (`application/json`, required): JSON object with fields `defaultLabel`, `defaultLabelObjectType`, `defaultLabelPlacementTypes`, `id`, `value`.

**Responses:** `200` — Label updated successfully · `404` — Label not found. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/label/create.do

[Request examples](https://epom.com/ad-server/docs/api/labels/post-label-create.md)

Create a new label.

**Request body** (`application/json`, required): JSON object with fields `defaultLabel`, `defaultLabelObjectType`, `defaultLabelPlacementTypes`, `id`, `value`.

**Responses:** `200` — Label created successfully. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/label/defaultObjectTypes.do

[Request examples](https://epom.com/ad-server/docs/api/labels/get-label-defaultobjecttypes.md)

Get default object types.

No parameters beyond authentication.

**Responses:** `200` — Default object types retrieved successfully. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/label/defaultPlacementTypes.do

[Request examples](https://epom.com/ad-server/docs/api/labels/get-label-defaultplacementtypes.md)

Get default placement types.

No parameters beyond authentication.

**Responses:** `200` — Default placement types retrieved successfully. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/label/list.do

[Request examples](https://epom.com/ad-server/docs/api/labels/get-label-list.md)

List all labels.

| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| `activeOnly` | query | boolean | no | When true, return only active (non-deleted) records |
| `dir` | query | string | no | Sort direction: ASC or DESC |
| `labels` | query | array<integer> | no | Filter by label IDs |
| `limit` | query | integer | no | Maximum number of records to return per page |
| `multisort` | query | array<object> | no | Multi-column sort configuration as a JSON array of objects with 'property' and 'direction' fields |
| `name` | query | string | no | Filter by entity name |
| `onlyData` | query | boolean | no | When true, return only data rows without metadata |
| `onlyTotal` | query | boolean | no | When true, return only the total count without data rows |
| `query` | query | string | no | Search query string to filter results by name or other searchable fields |
| `role` | query | integer | no | Filter by user role ID |
| `sort` | query | string | no | Field name to sort results by |
| `start` | query | integer | no | Pagination offset (0-based index of the first record to return) |

**Responses:** `200` — Labels retrieved successfully. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

### GET /rest-api/labels.do

[Request examples](https://epom.com/ad-server/docs/api/labels/get-labels.md)

List all labels (deprecated) *(deprecated)*

No parameters beyond authentication.

**Responses:** `200` — Successfully retrieved labels. Errors follow the [shared conventions](https://epom.com/ad-server/docs/api.md#error-codes).

## Related

- [REST API overview](https://epom.com/ad-server/docs/api.md) — authentication and conventions
- [API endpoint reference by tag](https://epom.com/ad-server/docs/api/endpoints.md)

<!-- Generated from the OpenAPI spec. Do not edit by hand. -->