List curation custom fields

GET

/api/v3/curations/custom-fields

const url = 'https://api.tryletterhead.com/api/v3/curations/custom-fields?api=true';
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);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/curations/custom-fields?api=true' \
  --header 'Authorization: Bearer <token>'

Returns the company’s curation custom field definitions — up to 20 per company. A custom field lets a data feed or RSS feed map a source path onto a value that isn’t one of the standard curation fields (see Create a data feed’s fieldMappings).

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true to authenticate with your company API key rather than a signed-in session.

Responses

200

200 OK

application/json

object

items

Array<object>

object

This field’s identifier — pass it to Delete a curation custom field.

integer

companyId

integer

name

string

key

Normalized from name. Used as the customFields key on a curation, and as the customField:<key> target in a data feed’s field mappings.

string

maxLength

integer

createdAt

string

updatedAt

string

message

string

total

integer

Example

{
  "items": [
    {
      "id": 3,
      "companyId": 999999999,
      "name": "Vendor SKU",
      "key": "vendor-sku",
      "maxLength": 60,
      "createdAt": "2026-06-01T12:00:00+00:00",
      "updatedAt": "2026-06-01T12:00:00+00:00"
    }
  ],
  "message": "Custom fields.",
  "total": 1
}

Still can’t find what you need? Contact support.