Skip to content

Get Engagement types

Endpoint

http
GET /unified/crm/engagement_types/{id}
Integrations supported
  • Capsule

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Response Body

id
string
REQUIRED · The engagement type's unique identifier
Supported in
  • Capsule
type
string
The engagement type's type
name
string
The engagement type's name
Supported in
  • Capsule
created_at
string · date-time
The date and time of the engagement type's creation
updated_at
string · date-time
The date and time of the engagement type's last update
remote_data
object
Raw data returned from the remote API call.