HTTP API - User Management

Any user that you’ve identified with a user id can be removed from Fullstory using our API. You can also delete in the Fullstory UI with the click of a button if your use case doesn't require automation.

Use this feature to comply with Right to be Forgotten / Right to Erasure requests from your end users.

Note: This call requires an Admin and Admin API key.

Users API Endpoints

The v2 API supports two ways to identify users:

• Fullstory-generated ID ({id}): A unique identifier automatically generated by Fullstory for each user.
• Your application-specific ID ({uid}): The ID you've given to the user and passed through the FS.identify() API. You can find this in the user card in the Fullstory app.

For complete API documentation, see Get User and Delete User in the Fullstory Developer Guide.

Get user data

The Get user API call retrieves user information. If you plan on deleting a user, it is recommended that you make this API call first to verify that the user you're about to delete is the one that you actually want to delete.

Example using uid

$ curl -H 'Authorization: Basic YOUR_API_KEY' https://api.fullstory.com/v2/users?uid=10154

  {
    "id": "FS_USER_ID_12345",
    "uid": "10154",
    "display_name": "Daniel Falko",
    "email": "daniel@falko.com",
    "is_being_deleted": false,
    "properties": {
      "account_type": "premium"
    }
  }

Delete user

The Delete user API call permanently deletes all user data related to this user. This includes sessions, events, custom user properties, as well as all of the raw page files and any corresponding session data on our servers.

This is an asynchronous call that kicks off a background operation and returns immediately. It returns an operation ID that you can use to query the status of the operation later.

Example using uid

$ curl -H 'Authorization: Basic YOUR_API_KEY' -X DELETE https://api.fullstory.com/v2/users?uid=10154

  {
    "id": "YnVsa3k6NTc0OTU2MzMzMTcwNjg4MA=="
  }

Bulk User Operations

For importing or managing large numbers of users, the v2 API provides bulk operation endpoints:

• Batch Import - Import up to 50,000 users in a single request.
• Stream Import - Create users asynchronously with request tracking.

See the Users API documentation in the Fullstory Developer Guide for complete details on all available endpoints.