DEdealhub
Custom Field

Get custom field definitions

Returns all custom field definitions for a specific parent object type

get/customFieldDefinition/{parentObjectType}

Request

  • Base URL
    https://api.app.subskribe.com
  • URL
    https://api.app.subskribe.com/customFieldDefinition/{parentObjectType}
  • Auth
    API key in header X-API-Key

Path parameters

parentObjectTypestring required

object type custom fields are attached to

Response

successful operation

idstring
parentObjectType'ACCOUNT' | 'ORDER' | 'ORDER_ITEM' | 'PLAN' | 'CHARGE' | 'INVOICE' | 'SALES_ROOM' | 'SUBSCRIPTION' | 'SUBSCRIPTION_ITEM' | 'OPPORTUNITY'
fieldType'STRING' | 'PICKLIST' | 'MULTISELECT_PICKLIST'
fieldNamestring
fieldLabelstring
optionsstring[]
requiredboolean
createdOninteger
updatedOninteger

Changes

No recorded changes to this operation across all 1 revision of this API.