Keywords are strings that can be attached to all major objects.

Attributes

Attribute Name	Type	Description	Attributes
`self`	`reference`	URL of the keyword	Read-only Non-null
`name`	`string`	Name of the keyword	Read-Write Non-null
`is_active`	`boolean`	`true` if the keyword should be allowed to be assigned to major objects	Read-Write Non-null

Filtering Results

This endpoint returns the full list of keywords by default. However, you may include an entity query parameter to only fetch keywords which are enabled for the entity.

An example request that only wanted keywords for contacts would like this:

GET /v1/keywords?entity=contact

All entities which support keywords are valid values for the entity filter:

Major Entity	Query String
Contact	`contact`
Company	`company`
Project	`project`
Opportunity	`opportunity`
Task	`task`
Appointment	`appointment`
Group	`group`
Note	`note`
Email	`email`
Form	`form`

📘
Auto-created Keywords
Implicitly created keywords are configured to apply to all entities. If a major object is created with a keyword which it is disabled, then the keyword will be changed so that it is active and enabled for the major entity.
You can toggle which keywords are enabled for a particular entity in the Daylite app preferences.

200200

400400