Get Object - SalesDesk Docs

Path Parameters

objectId

string

required

Unique system identifier for SDObjects

Response

SDObject

An SDObject schema

singularLabel

string

required

The name displayed for the Object. Editable for Custom objects and editable System objects

Required string length: 1 - 10000

pluralLabel

string

required

The plural name for the Object

Required string length: 1 - 10000

description

SDObject Description · object

required

Tiptap JSON formatted rich text. Editable for Custom objects and editable System objects

color

string

required

RGB Color as Hexadecimal. Used for highlighting. Editable for Custom objects and editable System objects

icon

string

required

Fontawesome/Phosphor Icon with format '[fa|ph]-*'. Editable for Custom objects and editable System objects

defaultView

enum<string>

required

An default view value for displaying records of this type

Available options:

TABLE,

CARD,

LIST,

KANBAN,

CALENDAR

fields

SDObject Field · object[]

required

Show child attributes

fields.type

enum<string>

required

The type of data used for the field (e.g. int, float, date, selection etc). Not editable

Available options:

string,

rich_text,

integer,

float,

boolean,

date,

date_time,

time_range,

duration,

currency_value,

phone_number,

email,

url,

domain,

file,

image,

video,

pdf,

priority,

probability,

rating,

progress,

color,

country,

currency,

icon,

single_option,

multi_option,

association,

roles,

profile_photo,

logo,

password,

positionable_image,

object_value,

charts,

sentiment,

icon_chooser,

object,

objects

fields.componentType

enum<string>

required

Dependent on Field type and indicates which UI component should be used to display this field. Editable for Custom objects and editable System objects

Available options:

checkbox,

color,

date,

date_time,

time_range,

duration,

file,

icon,

image_file,

positionable_image,

logo,

options_builder,

password,

pdf_file,

profile_photo,

rating,

rich_text,

select,

text,

toggle_switch,

typeahead_single_option,

typeahead_multi_option,

video_file,

charts,

sentiment

fields.creationType

enum<string>

required

Indicates who created the item. Not editable

Available options:

System,

User

fields.name

string

required

The name of the Field. Not editable

Required string length: 1 - 10000

fields.singularLabel

string

required

The name displayed for the Field. Editable for Custom objects and editable System objects

Required string length: 1 - 10000

fields.description

string

required

Tiptap JSON formatted rich text. Editable for Custom objects and editable System objects

fields.icon

string

required

Fontawesome/Phosphor Icon with format '[fa|ph]-*'. Editable for Custom objects and editable System objects

fields.toolTip

string | null

required

The tool tip to display for the field. Editable for Custom objects and editable System objects

fields.formatDescription

string | null

required

A description of the format for the field. Editable for Custom objects and editable System objects

fields.editable

boolean

required

Indicates if the field is editable for records. Editable for Custom objects. Not editable for System objects

fields.calculatedBy

enum<string>

required

Indicates the source of the field value: User, System or AI Agent. Not editable

Available options:

User,

System,

AIAgent

fields.hidden

boolean

required

Indicates if the field is visible for records. Editable for Custom objects. Not editable for System objects

fields.required

boolean

required

Indicates if the field is required for records. Editable for Custom objects. Not editable for System objects

fields.unique

enum<string>

required

Indicates if the field should have any Unique Constraints

Available options:

None,

Object,

Global

fields.defaultValue

any

required

Default value for the field for records. Editable for Custom objects and editable System objects

fields.maxLength

integer | null

required

Required range: 0 <= x <= 9007199254740991

fields.templateType

enum<string>

The type of template field

Available options:

Required,

Optional,

None

fields.associationLabel

string

The label displayed in the association sections for this Field. Editable for Custom objects and editable System objects

Required string length: 1 - 10000

fields.associationMultiplicity

enum<string>

Indicates whether one or more records can be associated. Not editable

Available options:

ONE,

MANY

fields.objectIds

integer[]

The SDObject ids whose records can be referenced from this field. If left empty then any records can be referenced.. Not editable

Unique identifier for the object

Required range: x >= 0

fields.supportsPast

boolean

Required by the date Field types to indicate if they support past dates. Editable for Custom objects. Not editable for System objects

fields.dateOnly

boolean

Required byt the Time Range field to indicate if time should be included as well as date. Editable for Custom objects. Not editable for System objects

fields.currency

enum<string>

The currency of the currency value Field. Not editable

Available options:

USD,

EUR,

GBP,

CAD,

AUD,

AED,

AFN,

ALL,

AMD,

ARS,

AZN,

BAM,

BDT,

BGN,

BHD,

BIF,

BND,

BOB,

BRL,

BWP,

BYN,

BZD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EEK,

EGP,

ERN,

ETB,

GEL,

GHS,

GNF,

GTQ,

HKD,

HNL,

HRK,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KHR,

KMF,

KRW,

KWD,

KZT,

LBP,

LKR,

LTL,

LVL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MOP,

MUR,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SDG,

SEK,

SGD,

SOS,

SYP,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

XAF,

XOF,

YER,

ZAR,

ZMK,

ZWL

fields.options

SDObject Field Option · object[]

Show child attributes

fields.options.value

string

required

The value of the option in the UI. Editable for Custom objects. Not editable for System objects

Required string length: 1 - 10000

fields.options.label

string

required

The label displayed for the option in the UI. Editable for Custom objects. Not editable for System objects

Required string length: 1 - 10000

fields.options.color

string | null

required

The color displayed for the option in the UI. Editable for Custom objects. Not editable for System objects

fields.options.icon

string | null

required

The Icon displayed for the option in the UI. Editable for Custom objects. Not editable for System objects

fields.options.hidden

boolean

required

Indicates if the option is available in the UI. Editable for Custom objects. Not editable for System objects

fields.options.creationType

enum<string>

Indicates who created the item. Not editable

Available options:

System,

User

name

string

required

The name of the SDObject. Not editable

Required string length: 1 - 10000

integer

required

Unique identifier for the object

Required range: x >= 0

baseObjectId

integer

required

The id of an SDObject that this one is derived from. The same as id if it is not derived from another.. Not editable

Required range: x >= 0

creationType

enum<string>

required

Indicates who created the item. Not editable

Available options:

System,

User

version

integer

required

Used to identify dirty writes

Required range: x >= 0

deleted

boolean

required

Indicates if the SDObject has been deleted. Not editable

editable

boolean

required

Indicates if some properties of the SDObject can be edited. Not editable

supportsUserCreation

boolean

required

Indicates if users can create records for this SDObject. Not editable

ownedBy

integer

required

A User Id

Required range: x >= 0

createdAt

integer

required

Required range: x >= 0

createdBy

integer

required

A User Id

Required range: x >= 0

updatedAt

integer

required

Required range: x >= 0

updatedBy

integer

required

A User Id

Required range: x >= 0

isTemplatable

boolean

API Reference

Path Parameters

Response