> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.beehiiv.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.beehiiv.com/_mcp/server.

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

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

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.

Reference: https://developers.beehiiv.com/api-reference/publication-fields/index

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `limit` (integer, optional) — A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
- `cursor` (string, optional) — **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.
- `page` (integer, optional) — **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.
- `status` (enum, optional) — Filter fields by whether they have been archived. Defaults to `active`.
  - Allowed values: `active`, `archived`, `all`

## Response

### 200

OK

- `data` (list of PublicationField, required) — An array of publication fields.
- `limit` (integer, optional) — The limit placed on the results. If no limit was specified in the request, this defaults to 10.
- `has_more` (boolean, optional) — **Cursor pagination only**: Indicates whether there are more results available after the current page. Only present when using cursor-based pagination.
- `next_cursor` (string, optional) — **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.
- `page` (integer, optional) — **Offset pagination only**: The page of results returned. Only present when using the deprecated `page` parameter.
- `total_results` (integer, optional) — The total number of results from all pages.
- `total_pages` (integer, optional) — **Offset pagination only**: The total number of pages. Only present when using the deprecated `page` parameter.

## Errors

### 400 Bad Request Error

Bad Request

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 401 Unauthorized Error

Unauthorized. The API key or OAuth access token is missing, invalid, or expired.

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 403 Forbidden Error

Forbidden

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 404 Not Found Error

Resource Not Found

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 429 Too Many Requests Error

Rate Limit Exceeded

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

### 500 Internal Server Error

Internal Server Error

- `status` (integer, required)
- `statusText` (string, required)
- `errors` (list of ErrorDetail, required)

## Types

### PublicationField

- `id` (string, required) — The prefixed ID of the publication field.
- `name` (string, required) — The merge tag key for the field. This is what content references, and it is unique within the workspace.
- `display` (string, required) — The human readable label for the field.
- `kind` (enum, required) — The type of value the field holds.
  - Allowed values: `text`, `number`, `boolean`, `date`, `color`, `url`, `image_url`, `rss_feed_url`, `json`
- `value_source` (enum, required) — Where the value for each publication comes from.
  - Allowed values: `static`, `fetched`
- `response_keys` (list of PublicationFieldResponseKey, required) — The keys declared within the fetched JSON response body. Empty unless `kind` is `json`.
- `status` (enum, required) — Whether the field is currently active or has been archived.
  - Allowed values: `active`, `archived`
- `created` (integer, required) — The time the field was created. Measured in seconds since the Unix epoch.
- `updated` (integer, required) — The time the field was last updated. Measured in seconds since the Unix epoch.
- `default_value` (string, optional) — The value used for publications that have not set one of their own. Null when the field has none configured; `json` and `rss_feed_url` fields are the only kinds not required to have one.
- `endpoint_url` (string, optional) — The URL the value is retrieved from. Present only when `value_source` is `fetched`, and may contain merge tags that resolve per publication.

### ErrorDetail

- `message` (string, required)
- `code` (string, required)

### PublicationFieldResponseKey

- `key` (string, required) — The name of the key within the JSON response body.
- `kind` (enum, required) — The type of value the key holds.
  - Allowed values: `text`, `number`, `date`, `url`, `image_url`

## Examples

**Response**

```json
{
  "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": "support@beehiiv.com",
      "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
}
```

**SDK Code**

```python Default
import requests

url = "https://api.beehiiv.com/v2/workspaces/publication_fields"

querystring = {"limit":"10"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Default
const url = 'https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Default
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Default
require 'uri'
require 'net/http'

url = URI("https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Default
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Default
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Default
using RestSharp;

var client = new RestClient("https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Default
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beehiiv.com/v2/workspaces/publication_fields?limit=10")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> Build your audience with beehiiv's API and SDKs. Create new subscribers and posts, get real-time notifications of subscription activity, and more.