all users

Get the users matched by the segment

For custom components:

RaiselyComponents.api.one('segments', '{uuid}').get('users', params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The uuid of the record

Query Params
boolean

Returns the full record when authenticated

string

Search query to find records matching

number

The number of records to limit per page

number

The pagination offset (in number of records)

string

The record attribute to filter on (use in conjunction with order)

string
enum

The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending

Allowed:
Headers
string

A valid HTTP Bearer token, required to access private records.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json