Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
CustomFields

List custom fields

Returns every custom field definition for the organization in display order. An organization defines at most 100, so the list is never paged.

GET
/v1/custom-fields

Returns every custom field definition for the organization in display order. An organization defines at most 100, so the list is never paged.

Authorization

apiKey
x-api-key<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/custom-fields"
{  "items": [    {      "id": "string",      "organizationId": "string",      "key": "string",      "label": "string",      "type": "text",      "options": [        "string"      ],      "defaultValue": "string",      "isRequired": true,      "sortOrder": 0,      "createdAt": "string",      "updatedAt": "string"    }  ]}

Related documentation

Create a custom field

Creates a new custom field definition and returns it with a 201 status; the field key must be unique, and an organization defines at most 100.

Delete a custom field

Permanently deletes a custom field definition by its ID. Use this endpoint to delete a custom field through the Samva email API.