| Field | Type | Required | Description | Example |
|---|---|---|---|---|
prefer |
T.nilable(::String) | ➖ | Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240) | heartbeat |
fields_ |
T.nilable(::String) | ➖ | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields |
id |
::String | ✔️ | N/A | |
include |
T.nilable(::String) | ➖ | The comma separated list of fields that will be included in the response | custom_fields |
proxy |
T::Hash[Symbol, ::Object] | ➖ | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | |
raw |
T.nilable(T::Boolean) | ➖ | Indicates that the raw request result should be returned in addition to the mapped result (default value is false) | |
x_account_id |
::String | ✔️ | The account identifier |