Get Users

Retrieve a list of users matching the supplied filter criteria

Query Parameters

uid string optional

The application-specific ID you've given to a user

email string optional

The email address associated with a user

display_name string optional

The nice-looking name for a user

is_identified boolean optional

Whether or not a user is anonymous or identified

page_token string optional

The token indicating the page of users to fetch. The same filter criteria should be supplied. This value should not be specified when requesting the first page of users.

include_schema boolean optional

Whether to include schemas in the response.

Responses

200

---

A successful response.

Schema

Example

---

Schema

results object[] required
The list of users that match the input filter criteria
Array [
id string required
The Fullstory assigned user ID
uid string optional
Possible values: <= 256 characters
The application-specific ID you've given to the user
display_name string optional
Possible values: <= 256 characters
The nice-looking name for this user
email string optional
Possible values: <= 128 characters
The email address associated with this user
is_being_deleted boolean required
Indicates whether or not this user is in the process of being removed
properties object optional
Properties that provide additional information about your user.
• Up to 500 unique properties are allowed.
• Property names must be a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_").
• Property names must start with an alphabetic character (A-Z or a-z).
• The maximum property name length is 512 characters.
• Property values may also contain nested objects. Properties within nested objects must still conform to the naming requirements. For nested objects, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters.
• Property values have a maximum size of 8192 bytes. If the value for the property is larger than this limit, the property will be rejected.
schema object optional
A mapping from fields to their types, whether inferred automatically or declared in the request.
properties object optional
A mapping of field names to their corresponding types.
type_conflicts object optional
Any fields that are associated with multiple types.
properties object optional
Any fields that are associated with multiple types.
app_url string optional
A link to the Fullstory app segments page, focused on this user.
]
total_records string required

The total number of users that matched the filter criteria

next_page_token string optional

The token that can be used in a subsequent request with the same filter criteria to fetch the next page of users

app_url string optional

A link to an anonymous segment in the Fullstory app containing these users.

{
  "results": [
    {
      "id": "987654321",
      "uid": "xyz123",
      "display_name": "Daniel Falko",
      "email": "daniel.falko@example.com",
      "is_being_deleted": false,
      "properties": {
        "pricing_plan": "paid",
        "popup_help": true,
        "total_spent": 14.55
      },
      "schema": null,
      "type_conflicts": null,
      "app_url": "https://app.fullstory.com/ui/orgid/segments/everyone/people:search:abc/user/xyz"
    }
  ],
  "total_records": "1200",
  "next_page_token": "asd543=",
  "app_url": "https://app.fullstory.com/ui/orgid/segments/everyone/people:search:abc/0"
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Loading...