Featurebase

Custom Fields

Custom fields allow you to collect additional information when users submit posts to your Featurebase platform. On this page, we'll explore the different custom field endpoints you can use to retrieve information about your configured fields programmatically.

The custom field model

The Custom Field model contains information about additional fields that can be shown on post submission forms. These fields can be configured to collect specific information from users when they create new posts.

Properties

  • Name
    _id
    Type
    string
    Description

    The unique identifier of the custom field. Example: "65d26304b2e65b1e1278170c"

  • Name
    label
    Type
    string
    Description

    The label displayed for the custom field. Example: "Your @username"

  • Name
    type
    Type
    string
    Description

    The type of the custom field (e.g., "text", "date", "number", "select", "multi-select", "checkbox").

  • Name
    required
    Type
    boolean
    Description

    Flag indicating whether this field is required during post submission.

  • Name
    placeholder
    Type
    string
    Description

    Optional placeholder text shown in the field.

  • Name
    public
    Type
    boolean
    Description

    Flag indicating whether this field is publicly visible.

  • Name
    internal
    Type
    boolean
    Description

    Flag indicating whether this field is for internal use only.

  • Name
    options
    Type
    Array<string>
    Description

    For field types that support options (like "select", "multi-select", "checkbox"), this contains the available choices.

  • Name
    createdAt
    Type
    Date
    Description

    The timestamp when the custom field was created.

  • Name
    updatedAt
    Type
    Date
    Description

    The timestamp when the custom field was last updated.

GET/v2/custom_fields

List custom fields

This endpoint allows you to retrieve a list of all custom fields configured in your Featurebase organization.

Request

GET
/v2/custom_fields
curl -G https://do.featurebase.app/v2/custom_fields \
  -H "X-API-Key: {token}"

Response

{
  "success": true,
  "results": [
    {
      "label": "Your @username",
      "type": "text",
      "required": true,
      "placeholder": "",
      "public": false,
      "internal": false,
      "options": [],
      "_id": "65d26304b2e65b1e1278170c",
      "createdAt": "2025-04-06T14:11:58.141Z",
      "updatedAt": "2025-04-06T14:11:58.141Z"
    }
  ]
}
GET/v2/custom_fields/:id

Get custom field by ID

This endpoint allows you to retrieve details for a specific custom field by providing its unique identifier.

Required URL Parameters

  • Name
    id
    Type
    string
    Description

    The unique identifier of the custom field to retrieve.

Request

GET
/v2/custom_fields/:id
curl -G https://do.featurebase.app/v2/custom_fields/65d26304b2e65b1e1278170c \
  -H "X-API-Key: {token}"

Response

{
  "label": "Your @username",
  "type": "text",
  "required": true,
  "placeholder": "",
  "public": false,
  "internal": false,
  "options": [],
  "_id": "65d26304b2e65b1e1278170c",
  "createdAt": "2025-04-06T14:11:58.141Z",
  "updatedAt": "2025-04-06T14:11:58.141Z"
}