Create, retrieve, update, and delete users in FullStory. Users can be anonymous or identified with a uid. Custom properties can be attached to enrich user profiles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/fullstory-users-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: FullStory Server Users API
description: The FullStory Server API is a RESTful API that enables developers to programmatically send user and event data to FullStory. It supports creating and updating individual users, batch importing users, sending server-side events, and batch importing events. The API uses JSON for request and response bodies and authenticates via API keys. Developers can use it to enrich FullStory session data with server-side context that is not available in the browser or mobile app.
version: '2.0'
contact:
name: FullStory Support
url: https://help.fullstory.com/
termsOfService: https://www.fullstory.com/legal/terms-and-conditions/
servers:
- url: https://api.fullstory.com
description: FullStory Production API Server
security:
- basicAuth: []
tags:
- name: Users
description: Create, retrieve, update, and delete users in FullStory. Users can be anonymous or identified with a uid. Custom properties can be attached to enrich user profiles.
paths:
/v2/users:
post:
operationId: createUser
summary: Create or update a user
description: Creates a new user or updates an existing user if a matching uid is found. Anonymous users can be created by omitting the uid field. The API returns the FullStory-assigned id along with the user data. Type suffixes are not required for custom properties in v2 as types are inferred automatically.
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
responses:
'200':
description: User created or updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: Invalid input provided
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized - invalid or missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded
headers:
X-RateLimit-Remaining:
description: Number of requests remaining in the current window
schema:
type: integer
Retry-After:
description: Seconds to wait before retrying
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: deleteUser
summary: Delete a user
description: Permanently deletes all user data related to the specified user, including sessions, events, custom user properties, raw page files, and corresponding session data. It is recommended to use the Get User endpoint first to verify the correct user before deletion.
tags:
- Users
parameters:
- $ref: '#/components/parameters/UidQuery'
responses:
'200':
description: User deleted successfully
'401':
description: Unauthorized - invalid or missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v2/users/{id}:
get:
operationId: getUser
summary: Retrieve a user
description: Retrieves details for a single user by their FullStory-assigned user ID. Returns user profile information including uid, display name, email, custom properties, and the FullStory app URL for the user.
tags:
- Users
parameters:
- $ref: '#/components/parameters/UserIdPath'
responses:
'200':
description: User retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized - invalid or missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
parameters:
UidQuery:
name: uid
in: query
required: true
description: The external user identifier used to identify the user to delete
schema:
type: string
UserIdPath:
name: id
in: path
required: true
description: The FullStory-assigned user ID
schema:
type: string
schemas:
CreateUserRequest:
type: object
description: Request body for creating or updating a user in FullStory
properties:
uid:
type: string
description: External user identifier. Omit to create an anonymous user.
display_name:
type: string
description: The display name for the user
email:
type: string
format: email
description: The email address for the user
properties:
type: object
description: Custom key-value properties to attach to the user. Type suffixes are not required in v2 as types are inferred automatically.
additionalProperties: true
schema:
type: object
description: Optional explicit type declarations for custom properties to override the default type inference
additionalProperties: true
Error:
type: object
description: Standard error response from the FullStory API
properties:
code:
type: integer
description: HTTP status code
message:
type: string
description: Human-readable error message
User:
type: object
description: A FullStory user object with profile information and custom properties
properties:
id:
type: string
description: The FullStory-assigned unique identifier for the user
uid:
type: string
description: The external user identifier provided during creation
display_name:
type: string
description: The display name for the user
email:
type: string
format: email
description: The email address for the user
properties:
type: object
description: Custom properties attached to the user
additionalProperties: true
schema:
type: object
description: Explicit type declarations for custom properties
additionalProperties: true
type_conflicts:
type: object
description: Any type conflicts detected in custom properties
additionalProperties: true
app_url:
type: string
format: uri
description: URL to view the user in the FullStory application
securitySchemes:
basicAuth:
type: http
scheme: basic
description: API key passed in the Authorization header using Basic authentication. Generate API keys from the FullStory app settings. Admin or Architect level keys are required for data retrieval and deletion operations.
externalDocs:
description: FullStory Server API Documentation
url: https://developer.fullstory.com/server/getting-started/