REST API
Labels
Endpoints

Endpoints

Use the labels endpoints to list, create, update, and delete labels owned by the authenticated user or workspace. The response shape is documented on the Label object page.

GET /labels

List all labels owned by the authenticated caller.

Query parameters

FieldTypeDescription
limitnumberPage size. Defaults to 20 and cannot exceed 100.
cursorstringPagination cursor returned by a previous list response.

Example request

curl --request GET \
  --url 'https://api.feedhive.com/labels?limit=20' \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response body

FieldTypeDescription
successbooleanWhether the request succeeded.
data.itemsLabel[]Returned label records for this page.
data.totalnumberTotal number of labels owned by the caller.
data.has_morebooleanWhether another page of labels is available.
data.next_cursorstring | nullCursor for the next page, or null when there are no more results.

GET /labels/:id

Fetch a single label by ID.

Path parameters

FieldTypeDescription
idstringLabel identifier.

Example request

curl --request GET \
  --url https://api.feedhive.com/labels/lbl_campaign_q4 \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response body

FieldTypeDescription
successbooleanWhether the request succeeded.
dataLabelRequested label record.

POST /labels

Create a new label.

Request body

FieldTypeDescription
titlestringRequired. Label name. Must be a non-empty string.

Example request

curl --request POST \
  --url https://api.feedhive.com/labels \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Campaign Q4"
  }'

Response body

FieldTypeDescription
successbooleanWhether the request succeeded.
dataLabelCreated label record.

PATCH /labels/:id

Update an existing label.

Path parameters

FieldTypeDescription
idstringLabel identifier.

Request body

FieldTypeDescription
titlestringNew label name. Must be non-empty when provided.

Example request

curl --request PATCH \
  --url https://api.feedhive.com/labels/lbl_campaign_q4 \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Campaign Q1"
  }'

Response body

FieldTypeDescription
successbooleanWhether the request succeeded.
dataLabelUpdated label record.

DELETE /labels/:id

Delete a label.

Path parameters

FieldTypeDescription
idstringLabel identifier.

Example request

curl --request DELETE \
  --url https://api.feedhive.com/labels/lbl_campaign_q4 \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response body

FieldTypeDescription
successbooleanWhether the request succeeded.
dataLabelDeleted label record.