What is the Labels API?
The Labels API (v2) allows you to manage custom classification tags (called labels) in your Clara account. Labels are useful for organizing transactions, users, or workflows based on internal categorization (e.g., “Client A”, “Internal Event”, “R&D”, etc.). With this API, you can:- Create, update, and delete labels
- Retrieve all existing labels or a specific one
- Bulk-delete labels when no longer needed
Available Endpoints
1⃣ List all labels
Use this endpoint to retrieve all the labels that have been created in your organization.You can use this data to show label options in a UI, filter transactions by label, or review current classification structures.
Endpoint
GET /v2/labels
cURL Request
cURL
Sample JSON Response
JSON
2⃣ Get Label by UUID
Use this to fetch full details for a specific label, including its name, description, status, and metadata.Endpoint
GET /v2/labels/{uuid}
cURL Request
cURL
Sample JSON Response
JSON
3⃣ Create multiple Labels
Use this to create a new label, specifying its name and an optional description. You can later assign this label to transactions or users.Endpoint
POST /v2/labels
cURL Request
cURL
Sample JSON Response
JSON
4⃣ Update a Label details
Use this endpoint to modify an existing label, such as changing the label name or updating its description.Endpoint
PATCH /v2/labels/{uuid}
cURL Request
cURL
5⃣ Delete a single Label
Use this to delete a single label by UUID. This is useful when a label is no longer relevant or has been replaced by another. ⚠️ Note: Deleting a label doesn’t remove it from historical data, but it will no longer be assignable.Endpoint
DELETE /v2/labels/{uuid}
cURL Request
cURL
6⃣ Delete Multiple Labels
Use this endpoint to bulk-delete labels. This is especially useful for cleanup tasks or automated workflows where multiple labels must be removed at once.Endpoint
POST /v2/labels/delete
cURL Request
cURL
💡 Tip: Labels can be used across transactions, reports, and internal workflows for custom tracking and analysis. **⚠️ Note: **Once deleted, a label cannot be reassigned to new entities.
Endpoint Reference
GET /api/v2/labels
List all labels (v2)
POST /api/v2/labels
Create labels (v2)
Request Body (CreateLabelsRequest):
PUT /api/v2/labels/{uuid}
Update label (v2)
Parameters:
Request Body (
UpdateLabelRequest):
DELETE /api/v2/labels/{uuid}
Delete label (v2)
Parameters:
DELETE /api/v2/labels/bulk-delete
Bulk delete labels (v2)
Request Body (BulkDeleteLabelsRequest):