List publication fields <Badge intent="info" minimal outlined>OAuth Scope: publication_fields:read</Badge>

GET

https://api.beehiiv.com/v2/workspaces/publication_fields

GET

/v2/workspaces/publication_fields

curl -G https://api.beehiiv.com/v2/workspaces/publication_fields \
     -H "Authorization: Bearer <token>" \
     -d limit=10

{
  "data": [
    {
      "id": "pub_field_00000000-0000-0000-0000-000000000000",
      "name": "support_email",
      "display": "Support email",
      "kind": "text",
      "value_source": "static",
      "response_keys": [],
      "status": "active",
      "created": 1700000000,
      "updated": 1700000000,
      "default_value": "[email protected]",
      "endpoint_url": null
    },
    {
      "id": "pub_field_11111111-1111-1111-1111-111111111111",
      "name": "weather",
      "display": "Local weather",
      "kind": "json",
      "value_source": "fetched",
      "response_keys": [
        {
          "key": "temperature",
          "kind": "text"
        },
        {
          "key": "icon",
          "kind": "image_url"
        }
      ],
      "status": "active",
      "created": 1700000001,
      "updated": 1700000001,
      "default_value": null,
      "endpoint_url": "https://api.example.com/weather"
    }
  ],
  "limit": 10,
  "has_more": false,
  "next_cursor": null
}

Currently in beta

This feature is currently in beta and the API is subject to change.

Retrieve the publication fields defined for the workspace. Publication fields hold a value per publication that content can reference through a merge tag. Archived fields are excluded unless the status parameter asks for them.

Requires an API key with access to every publication in the workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional

A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.

cursorstringOptional

Cursor-based pagination (recommended): Use this opaque cursor token to fetch the next page of results. When provided, pagination will use cursor-based method which is more efficient and consistent than offset-based pagination.

pageintegerOptional

Offset-based pagination (deprecated): Page number for offset-based pagination. Please migrate to cursor-based pagination using the cursor parameter. If not specified, results 1-10 from page 1 will be returned.

statusenumOptional

Filter fields by whether they have been archived. Defaults to active.

Allowed values:

Response

datalist of objects

An array of publication fields.

limitintegerOptional

The limit placed on the results. If no limit was specified in the request, this defaults to 10.

has_morebooleanOptional

Cursor pagination only: Indicates whether there are more results available after the current page. Only present when using cursor-based pagination.

next_cursorstringOptional

Cursor pagination only: The cursor token to use for fetching the next page of results. This will be null if has_more is false. Only present when using cursor-based pagination.

pageintegerOptional

Offset pagination only: The page of results returned. Only present when using the deprecated page parameter.

total_resultsintegerOptional

The total number of results from all pages.

total_pagesintegerOptional

Offset pagination only: The total number of pages. Only present when using the deprecated page parameter.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error