User API
Manage user profiles, subscriptions, storage usage, and developer access within organizations.
Endpoint Base
https://api.storylinezads.com/userAll endpoints in this section are relative to this base path. Use this prefix for all requests to the User API.
User Profile
Retrieve user profile information from the authentication provider (Clerk).
Get Current User Profile
/user/meGet Current User Profile - GET /user/me
Retrieves the authenticated user's own profile data, filtered for frontend safety. Data is sourced directly from the Clerk API.
Get Other User Profile
/user/user/{user_id}Get Other User Profile - GET /user/user/{user_id}
Retrieves limited public information about another user identified by their Clerk User ID. Data is sourced directly from the Clerk API.
Get Multiple Users (Batch)
/user/users/batchGet Multiple Users (Batch) - POST /user/users/batch
Retrieves limited public information about multiple users in a single request. This is more efficient than making individual calls to `/user/{user_id}` when you need to fetch data for multiple users. Data is sourced directly from the Clerk API.
Storage Management
Monitor storage usage for individual users and entire organizations.
Get User Storage Usage
/user/storageGet User Storage Usage - GET /user/storage
Retrieves storage usage information (in bytes) for the *authenticated user* within a specific organization. Requires the user to be a member or owner of the organization.
Parameters:
- org_id: The ID of the organization (e.g., `org_xxxx`) for which to retrieve the authenticated user's storage usage. The user must be a member or owner of this organization.
Get Organization Storage Usage
/user/org/storageGet Organization Storage Usage - GET /user/org/storage
Retrieves total storage usage information for an entire organization. Optionally includes a breakdown by user. Requires the user to be a member or owner of the organization.
Parameters:
- org_id: The ID of the organization (e.g., `org_xxxx`) to retrieve storage information for. The user must be a member or owner of this organization.
- include_breakdown: Set to `true` (case-insensitive) to include a detailed list (`breakdown` array) showing storage usage per individual user within the organization. Defaults to `false` if omitted or set to any other value. Useful for administrators needing granular insights.
Subscription Management
Monitor subscription details, usage limits (projects, storage, content processing), and billing periods for the user within an organization.
Get Subscription Details
/user/subscriptionGet Subscription Details - GET /user/subscription
Retrieves detailed subscription status and usage information for the *authenticated user* within a specific organization. Requires organization membership or ownership.
Parameters:
- org_id: The ID of the organization (e.g., `org_xxxx`) for which to retrieve the user's subscription and usage details. The user must be a member or owner of this organization.
Get Project Usage
/user/projects/usageGet Project Usage - GET /user/projects/usage
Retrieves project-specific usage information for the *authenticated user* within an organization, focusing on daily and monthly limits and current counts. Requires organization membership or ownership.
Parameters:
- org_id: The ID of the organization (e.g., `org_xxxx`) for which to retrieve the user's project usage details. The user must be a member or owner of this organization.
Get Extra Projects Information
/user/projects/extrasGet Extra Projects Information - GET /user/projects/extras
Retrieves information about extra projects created beyond the monthly subscription limit, including the count and estimated cost. Primarily relevant for Team tier users. Requires organization membership or ownership.
Parameters:
- org_id: The ID of the organization (e.g., `org_xxxx`) for which to retrieve extra project information. The user must be a member or owner of this organization.
Developer Access
Check the developer API access status for the authenticated user.
Get Developer Access Status
/user/developer-statusGet Developer Access Status - GET /user/developer-status
Retrieves the developer API access status for the *authenticated user*. Checks both the user's profile setting (`developer_api_clearance`) and any pending access requests.