Get a custom field by ID | Solvimon

Requires the CUSTOM_FIELD.VIEW permission.

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

referencestringformat: "^\S+$"0-256 characters

resource_typeenum

integration_idstring

The resource ID of the integration.

integration_referencestringformat: "^\S+$"0-256 characters

The reference of the integration.

object_typestring or nullRead-only

idstring or nullRead-only

namestring or null

descriptionstring or null

multiple_valuesboolean or null

unique_valueboolean or null

copy_value_to_invoiceboolean or null

typeenum or null

Allowed values:

enum_valueslist of strings or null

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

1	{
2	"reference": "custom_field_001",
3	"resource_type": "PLATFORM",
4	"integration_id": "int_1234567890",
5	"integration_reference": "ext_ref_987654321",
6	"object_type": "customer",
7	"id": "cf_8a7b6c5d4e3f2a1b",
8	"name": "Preferred Contact Method",
9	"description": "Customer's preferred method of contact",
10	"multiple_values": false,
11	"unique_value": true,
12	"copy_value_to_invoice": false,
13	"type": "STRING",
14	"enum_values": [
15	"Email",
16	"Phone",
17	"SMS"
18	]
19	}

1	curl https://test.api.solvimon.com/v1/custom-fields/ \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json"