Skip to main content
GET
/
records
/
{recordId}
{
  "objectId": 1,
  "fieldValues": [
    {
      "fieldName": "<string>",
      "value": "<unknown>"
    }
  ],
  "name": "<string>",
  "id": 1,
  "creationType": "System",
  "version": 1,
  "objectVersion": 1,
  "deleted": true,
  "sharedWorkspaceIds": [
    1
  ],
  "ownedBy": 1,
  "createdAt": 1,
  "createdBy": 1,
  "updatedAt": 1,
  "updatedBy": 1,
  "isTemplate": true
}

Path Parameters

​
recordId
string
required

Unique system identifier for SDRecords

Response

SDRecord

An SDRecord schema

​
objectId
integer
required

The object that this record has been created for. Not editable

Required range: x >= 0
​
fieldValues
SDRecord Field Value · object[]
required
​
name
string
required

The name of the SDRecord. Not editable

Required string length: 1 - 10000
​
id
integer
required

Unique identifier for the record

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. Not editable

Required range: x >= 0
​
objectVersion
integer
required

The version of the SDObject that this record was created for. Not editable

Required range: x >= 0
​
deleted
boolean
required

Indicates if the SDRecord has been deleted. Not editable

​
sharedWorkspaceIds
integer[]
required

Unique identifier for the record

Required range: x >= 0
​
ownedBy
integer | null
required

The owner of this SDRecord. Not editable

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
​
isTemplate
boolean