Attribute

Retrieve a custom attribute definition.

The entityType segment of the URL must match the type the definition belongs to (e.g. Account, Person, Deal).

get/api/v1/attributes/definitions/{definitionUid}

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/attributes/definitions/{definitionUid}
Auth: none declared

Path parameters

definitionUidstring nullable required

The definition's unique identifier

Response

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

ControlTypestring nullable

ControlParamsstring nullable

Labelstring nullable

SystemNamestring nullable

EntityType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

0 - None, 1 - Account, 2 - Person, 3 - Deal, 4 - Case, 5 - Invoice, 6 - EmailLog, 7 - Plan, 8 - DiscountCoupon, 9 - AddOn, 10 - Task, 11 - Segment, 12 - Broadcast, 13 - Article

Positioninteger nullable

Hiddenboolean

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "ControlType": "string",
  "ControlParams": "string",
  "Label": "string",
  "SystemName": "string",
  "EntityType": 0,
  "Position": 0,
  "Hidden": false
}

Changes

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