Search All Users or Groups

NOTE: As of Rev v7.15, Teams will not be returned in the search response.
NOTE: As of Rev v7.22, the Count parameter may be used to specify the number of results to return.

GET
/api/v1/search/access-entity

Request Parameters

Name Type Description Required
type query user or group – will return all entities if not specified
q query Blank search if not provided.
scrollId query The scrollId returned in initial response.
count query Specifies the number of results to return. If not used, default return is 1000. Maximum results returned is 1000. If more than 1000 are returned, only the first 1000 are displayed.

Example Response

{
  "accessEntities": [
  {
    "Name": "Sales Group",
    "Id": "6aa49448-b866-412d-89b0-9ceb49f8afbd",
    "EntityType": "Group"
  },
  {
    "UserName": "john.smith",
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "john.smith@company.com",
    "Id": "094146e3-9971-45f6-80df-d918dc0fabdd",
    "EntityType": "User"
  } ],
  "totalEntities": 2,
  "scrollId": "cXVlcnlBbmRGZXRjaDsxOzM2ODpJcmhxdnN0NlJXQ0NCOWFpaXlrZzlROzA7"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Find a Single User

GET
/api/v1/users/{userId}
GET
/api/v1/users/{username}?type=username
GET
/api/v1/users/{email}?type=email

**Use the appropriate request parameter with the desired method to retrieve user details.**

Request Parameters

Name Type Description Required
userId string GUID for the user. Yes
username string Username for the user. Yes
email string Email address for the user. Yes

Example Response

{
  "userId": "32346556-b91d-46f0-a370-786116536521",
  "firstname": "John",
  "lastname": "Smith",
  "language": null,
  "username": "john.smith",
  "email": "john.smith@company.com",
  "title": "Directory",
  "phone": null,
  "groups": [
  {
    "id": "94523458-1e5f-42d7-8765-abdfaa879bc4",
    "name": "All Users"
  } ],
  "teams": [
  {
    "id": "270b4266-9ada-4029-8e25-d773kd93ld94",
    "name": "Marketing"
  } ],
  "roles": [
  {
    "id": "79dbe154-f518-43dc-b60b-412e3d4f1c2f",
    "name": "Media Admin"
  } ]
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

List All Users Within a Specific Group

NOTE: As of Rev v7.18, this API call is available.

GET
api/v1/search/groups/{groupId}/users

Request Parameters

Name Type Description Required
groupId path GUID for the group. Yes

Example Response

{
  "userIds": [
    "91c247a0-59d8-4f02-a912-33327q2a8765",
    "461274d9-e3bd-4fd6-9c56-b7eq76a1c541",
    "dc7218d3-b765-4470-a460-39588c5qf855",
    "3ba205d4-3185-4c23-ba9e-73q45d945378",
    "df4254f2-7a7b-4558-92b1-e7173dc2qdd9",
    "8b6237c0-d6a6-4562-889d-e8024ffqe002",
    "0562db22-d2b0-4602-ae04-b6cd79d7q311",
    "3b7249e9-c286-4315-bda5-fcff279q86ac",
    "4d22911e-80ad-496c-ba54-0986bf39qaf5"
  ],
  "totalUsers": 9,
  "scrollId": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAABLT8WY2RVZG5KNnpUcm1aNzRVQlJ0aENQUQ=="
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error