Get all custom fields | Solvimon

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

{
  "data": [
    {
      "reference": "customer_loyalty_level",
      "resource_type": "CUSTOMER",
      "integration_id": "int_1234567890abcdef",
      "integration_reference": "loyalty_program_2024",
      "object_type": "custom_field",
      "id": "cf_8a7b9c3d-4e5f-6789-abcd-1234567890ef",
      "name": "Customer Loyalty Level",
      "description": "Indicates the loyalty tier assigned to the customer",
      "multiple_values": false,
      "unique_value": true,
      "copy_value_to_invoice": false,
      "type": "ENUM",
      "enum_values": [
        "Bronze",
        "Silver",
        "Gold",
        "Platinum"
      ]
    }
  ],
  "links": {
    "first": "https://api.solvimon.com/v1/custom-fields?page=1&limit=10",
    "current": "https://api.solvimon.com/v1/custom-fields?page=1&limit=10",
    "next": "https://api.solvimon.com/v1/custom-fields?page=2&limit=10"
  },
  "page": 1,
  "limit": 10,
  "total_number_of_pages": 3
}

Requires the CUSTOM_FIELD.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

resource_typestringOptional

The resource type of the custom field

referencestringOptional

The reference of the custom field

integration_idstringOptional

The ID of the custom field integration

order_bystringOptional

The parameter by which the response is ordered

order_directionstringOptional

The order direction by which the response is ordered

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

Response

datalist of objects

linksobject

pageinteger or null

limitinteger or null

total_number_of_pagesinteger or nullDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors