Skip to main content
GET
/
v1
/
admin
/
relationships
/
custom-fields
List custom field definitions
curl --request GET \
  --url https://{operatorDomain}/v1/admin/relationships/custom-fields \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "cfld_01h...",
    "key": "<string>",
    "label": "<string>",
    "dataType": "text"
  }
]

Authorizations

Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Response

200 - application/json

List of custom field definitions

id
string
Example:

"cfld_01h..."

key
string
label
string
dataType
string
Example:

"text"