Skip to main content

Get custom object schema details

GET 

/metadata/custom_objects/:object_name

Get custom object schema details

Support:

ProviderSupported
HubspotYes
SalesforceYes
PipedriveNo
MS DynamicsNo

Request

Path Parameters

    object_name stringrequired

    The unique name of the custom object. For Salesforce, this should end with __c. For Hubspot, this will typically be the singular form of the object.

    Example: MyCustomObject__c

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Responses

CustomObject

Schema
    name stringrequired
    description stringnullablerequired
    labels objectrequired
    singular stringrequired
    plural stringrequired
    fields object[]required
  • Array [
  • id stringrequired

    The machine name of the property as it appears in the third-party Provider. In Salesforce, this must end with __c.

    label stringrequired

    The human-readable name of the property as provided by the third-party Provider.

    description string

    A description of the field.

    is_required boolean

    Whether or not this field is required. Must be false for Salesforce boolean fields.

    default_value object

    The default value for the property. Only supported for Salesforce.

    oneOf

    string

    group_name string

    Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't.

    type property_typerequired

    Possible values: [text, textarea, number, picklist, multipicklist, date, datetime, boolean, url, other]

    Type of the field.

    :::note picklist and multipicklist property types are currently only supported in Salesforce and Hubspot :::

    :::note url property type currently is only natively supported in Salesforce. :::

    Support:

    TypeHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaTextareatext
    numbernumber-numberInt/Double (depending on scale)double
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanbool-booleancheckboxCheckboxenum
    urlNot SupportedUrlNot Supported
    precision number

    Only applicable in Salesforce. If not given, will default to 18.

    scale number

    Only applicable in Salesforce. If not given, will default to 0.

    options object[]

    The list of options for a picklist/multipicklist field.

  • Array [
  • label stringrequired
    value stringrequired
    description string

    A description of this option.

    hidden boolean

    Defaults to false.

  • ]
  • raw_details object

    The raw details of the property as provided by the third-party Provider, if available.

    property name* any

    The raw details of the property as provided by the third-party Provider, if available.

  • ]
Loading...