Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
CustomFields

List custom fields

Returns a paginated list of custom field definitions for the organization. Use this endpoint to list custom fields through the Samva email API.

GET
/v1/custom-fields

Returns a paginated list of custom field definitions for the organization.

Authorization

apiKey
x-api-key<token>

In: header

Query Parameters

page?string|null
limit?string|null

Response Body

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"    }  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}

Create a custom field

Creates a new custom field definition and returns it with a 201 status; the field key must be unique.

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.