| 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,email,username,name,first_name,last_name,bot,active,unified_custom_fields |
filter |
T.nilable(Models::Operations::MessagingListUsersQueryParamFilter) | ➖ | Filter parameters that allow greater customisation of the list response | |
next_ |
T.nilable(::String) | ➖ | The unified cursor | |
page |
T.nilable(::String) | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The page number of the results to fetch |
|
page_size |
T.nilable(::String) | ➖ | The number of results per page (default value is 25) | |
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) | |
updated_after |
Date | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Use a string with a date to only select results updated after that given date |
2020-01-01T00:00:00.000Z |
x_account_id |
::String | ✔️ | The account identifier |