GET Get Custom Fields

Base URLs

Demo URL: https://demoapi.openletterconnect.com/api/v1

Production URL: https://api.openletterconnect.com/api/v1

{{base_url}}/custom-fields?meta.account_id=123-1234-12342355-12323534634

Description

This endpoint is used to retrieve custom fields associated with a specific account. By providing the account ID, you can access a list of custom fields that can be utilized for various purposes within the system. The response will include the keys, values, and default values of the custom fields available for the specified account.

AUTHORIZATION

Bearer Token

• Token: {{jwt_token}}

Params

Name	Data Type	Required	Description	Value
meta.account_id	string	Yes	A unique identifier for the account	123-1234-12342355-12323534634

Example Request

curl --location -g '{{base_url}}/custom-fields'

Example Response

{
  "message": "Success",
  "data": [
    {
      "key": "{{CF.AGE}}",
      "value": "Age",
      "defaultValue": ""
    },
    {
      "key": "{{CF.WIFE_NAME}}",
      "value": "Wife_Name",
      "defaultValue": ""
    },
    {
      "key": "{{CF.MY_NAME}}",
      "value": "My_Name",
      "defaultValue": ""
    }
  ]
}