Uscreen offers a powerful API that allows you to integrate your platform with external systems and customize your workflow.

This article provides an overview of our API capabilities, access requirements, and implementation details.

API Access

To get started with the API, reach out to your Customer Success Manager or our Support team to get your API authorization key.

📝 NOTE: Uscreen API access is available to stores on UscreenPlus. If you're not currently on the Plus plan yet but need API access, you can reach out to sales@uscreen.tv to discuss upgrade options.

Publisher API Documentation

You can access our API documentation at:

Access Uscreen API

Technical Implementation

📝 NOTE: While our Support Team can provide basic guidance on API access and documentation, custom development implementation is out of the scope. For further assistance, please consult with a developer familiar with API integrations.

Authentication

All API requests require authentication using your API key. Include your API key in the request headers:

Authorization: YOUR_API_KEY

Content Types

For most endpoints, you'll need to set the appropriate content type:

Content-Type: application/json
Accept: application/json

Commonly Used Endpoints

Here are some commonly used endpoints in the Publisher API:

Customers

POST /customer:
- Create a new user
- Accepts a tags parameter (array of strings) to tag the customer at creation in a single call
GET /customers:
- Retrieve users
- Responses now include a tags field as an array of tag name strings (e.g. ["vip", "annual-member"])
PUT /customers/{id}:
- Update user details (including payment_user_id)
- Accepts a tags parameter to update a customer's tags
- ⚠️ This is a replace operation, so the provided list replaces all existing tags

Access Management

POST /customers/{id}/accesses: Grant a user access to a specific membership
DELETE /customers/{id}/accesses/{access_id}: Revoke a user's access

Invoices

GET /invoices: Retrieve a list of invoices (includes tax details)
GET /invoices/{id}: Retrieve a specific invoice

Group Subscriptions

POST /groups: Create a new group
GET /groups: List all groups
POST /groups/{id}/members: Add a member to a group
DELETE /groups/{id}/members/{user_id}: Remove a member from a group

🔗 Learn more about Group Subscriptions

Sessions & SSO

POST /customers/{customer_id}/tokenized_url: Generate a one-time magic link for SSO-style logins

Content

GET /contents: Get a paginated list of contents (videos, collections, and live events)
GET /contents/{id}: Get details for a specific video, collection, or live event

Offers

GET /offers: Retrieve available subscription plans
GET /offers/{id}: Get details for a specific offer

ℹ️ INFO: API responses for content, categories, and users now include a legacy_id field. You can also set legacy_id on users via the API. This is especially useful for creators migrating from other platforms who need to match records between systems.

Test the Implementation

Uscreen Interface

The simplest way to test the API is directly through our interactive documentation.

Authorize

Navigate to the Publisher API Documentation
Click Authorization
Enter your API key into the Header Value
Click Authorize

Test Request

Expand the endpoint you want to test
Fill in the required parameters
Click Try it out
Click Execute to run the request
Review the server response to ensure it's working as expected

Postman API

Postman is a popular API client that makes it easy to create, share, test, and document APIs.

Configure

Sign up or log in to your Postman account
Navigate to Workspaces
Create a Workspace if you haven't done so, or open an existing one
In Collections, click New
Select HTTP

Test Request

Select the appropriate HTTP Method
Input the Base URL (Publisher API) + your chosen endpoint
Fill out the required Headers and Parameters
Click Send and wait for a Response

💡 TIP: Always test your implementation thoroughly before deploying to production. Use error handling to manage rate limit exceptions gracefully.

cURL Command

For command-line testing, cURL is a versatile option.

Option 1: Authorization (Recommended)

curl -X POST "https://uscreen.io/api/publisher/[API endpoint]" \
  -H "accept: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Option 2: X-Store-Token (Also Valid)

curl -X POST "https://uscreen.io/api/publisher/[API endpoint]" \
  -H "accept: application/json" \
  -H "X-Store-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Custom Test Environment

For more comprehensive testing:

Create a test user in your account to simulate API interactions
Set up a test script in your preferred programming language
Implement error handling to manage rate limits and other potential issues
Create test cases for different scenarios and edge cases

⚠️ WARNING: Always use test accounts and data when testing the API. Never use actual customers' data for testing purposes.

Rate Limits

To ensure optimal performance and fair usage for all customers, the Publisher API has the following rate limits:

General API endpoints: 100 calls per minute
Sessions endpoint: 10 calls per 5 minutes

📝 NOTE: Please design your integration to work within these constraints by implementing proper request throttling and error handling in your code.

Other Limitations

Webhook creation and deletion via API is not currently supported.
When querying a User ID through the Publisher API based on webhook events, it is normal to receive a Record not found error for Admin accounts.
Webhooks may be triggered with up to a 10-minute delay, depending on system availability.

Common Use Cases

Here are some real-world scenarios where the Publisher API can help:

Custom Checkout Workflows

Use the API to create users and grant access after a payment is completed through an external payment provider (like Stripe or a third-party checkout).
🔗 Learn more about Custom Checkout Solutions

Single Sign-On (SSO)

Use the tokenized_url endpoint to log users into Uscreen after they've been authenticated on your own platform.
This generates a one-time magic link that creates a session in the browser.

📝 NOTE: This SSO method only works in web browsers and will not work for native mobile or TV apps.

Member Management from External Systems

Sync member data between Uscreen and your CRM, LMS, or other software by creating, updating, and retrieving users via the API.

B2B group onboarding

Automate group subscription management for corporate or institutional clients by creating groups and managing members programmatically.
🔗 Learn more about Group Subscriptions

Accounting and reporting

Pull invoice data (including tax details) to feed into your accounting software or build custom financial reports.

Recent API Updates

Here's a summary of recent changes and additions to the Publisher API.

	Update
May 2026	`tags` field on customer endpoints. `GET /customers` and `GET /customers/{id}` now return a `tags` array. `PUT /customers/{id}` and `POST /customers` now accept a `tags` array. The PUT operation replaces the full tag set. Tag changes automatically trigger the `USER_UPDATED` webhook.
April 2026	`payment_user_id` can now be updated using API. The PUT user endpoint now accepts `payment_user_id` for users who don't already have one set. The update is blocked if the user has an active subscription or an attached payment method.
April 2026	Invoice endpoints now include tax details. `GET /invoices` and `GET /invoices/{id}` now return tax information in their responses, making it easier to build accounting and reporting integrations.
April 2026	Group Subscriptions API. You can now manage groups and group members via the API. Create groups, add or remove members, and delete groups programmatically.
April 2026	`legacy_id` field. API responses for content, categories, and users now include a `legacy_id` field. You can also set `legacy_id` on users via the API, useful for creators migrating from other platforms.

ℹ️ INFO: For full details on any endpoint, refer to the Publisher API Documentation.

Alternative Options

If the API doesn't meet your specific needs, we offer other integration options.

🔗 Learn more about Webhooks

Receive real-time notifications about events in your Uscreen account

🔗 Learn more about Zapier Integration

Connect Uscreen with 7,000+ other apps without coding

FAQs

Is there an endpoint for products?

The Publisher API mainly allows you to manage customer data and content access. You can retrieve data on your offers using the /offers endpoint.

Can I use the Publisher API for email and password login?

Yes, our Publisher API allows you to create new users with email and password credentials. Additionally, we provide a tokenized URL endpoint for creating user sessions.

Will the Publisher API work with my mobile apps?

The Publisher API can also be used to retrieve data for mobile apps, but certain features like the SSO functionality (tokenized_url) will only work in web browsers, not in native mobile or TV apps.

Welcome to Uscreen! Get Started with Our Platform Walkthrough

Unique IDs in Uscreen

Uscreen Terminology

Uscreen Webhooks

Integrate Klaviyo with Uscreen