Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ghost.org/llms.txt

Use this file to discover all available pages before exploring further.

Labels allow publishers to organize members into internal segments. Labels can be applied when creating or updating members, and can also be managed directly with the labels resource.

​
The label object

Whenever you fetch, create, or edit a label, the API responds with an array of one or more label objects. 
// GET /admin/labels/?limit=100&page=1
{
    "labels": [
        {
            "id": "6958473e4c66da000199e33e",
            "name": "VIP",
            "slug": "vip",
            "created_at": "2026-01-02T22:31:26.000Z",
            "updated_at": "2026-01-02T22:31:26.000Z"
        },
        {
            "id": "6958473e4c66da000199e33f",
            "name": "Trial",
            "slug": "trial",
            "created_at": "2026-01-02T22:31:26.000Z",
            "updated_at": "2026-01-02T22:31:26.000Z"
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "limit": 100,
            "pages": 1,
            "total": 2,
            "next": null,
            "prev": null
        }
    }
}
KeyDescription
idUnique identifier for the label
nameHuman-readable label name
slugURL-safe identifier generated from the label name
created_atDate and time the label was created
updated_atDate and time the label was last updated
countRelated resource counts, included when requested

​
Parameters

When retrieving labels from the Admin API, it’s possible to use the include, filter, fields, limit, page, and order parameters. Available include values:
  • count.members - include the number of members assigned to each label
For browse requests, it’s also possible to use limit, page, and order parameters as documented in the Content API.

​
Creating a label

// POST /admin/labels/
{
    "labels": [
        {
            "name": "VIP"
        }
    ]
}

​
Updating a label

// PUT /admin/labels/{id}/
{
    "labels": [
        {
            "name": "Paid members"
        }
    ]
}

​
Deleting a label

Use DELETE /admin/labels/{id}/ to delete a label.