Get users

get

https://usermgmt-api.optimizely.com/api/users

Get a page of users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

includeExternalStatus

boolean

Include the external status of the user.

externalUserId

string

External ID of the user.

firstName

string

First name of the user.

lastName

string

Last name of the user.

string

Email address of the user.

homeOrganizationId

string

ID of the home organization the user belongs to.

organizationId

string

ID of an organization the user collaborates in.

userGroupIds

array of strings

IDs of the user groups the user belongs to.

userGroupIds

userIds

array of strings

IDs of the users.

userIds

matchAnyUserGroups

boolean

Set to true to filter the results by membership in any of the userGroupIds you specify. Set to false to filter the results by membership in all of the userGroupIds you specify.

properties

array of objects

Properties of the user.

properties

isVirtual

boolean | null

beforeLastLoggedIn

string | null

Filter users whose last logged in date is on or before this date.

afterLastLoggedIn

string | null

Filter users whose last logged in date is on or after this date.

size

int32

Number of results to include per page.

offset

int32

Offset paging of results.

Responses

401

Unauthorized access to endpoint.

403

Forbidden access to endpoint.

500

A server error occurred, please try again.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The users response.

400The request was invalid or cannot be otherwise served. An accompanying error message will explain further.