Skip to main content
GET
/
pixelStripeApi
/
projects
/
{id}
curl -G https://api.streampixel.io/pixelStripeApi/projects/[YOUR_PROJECT_ID] \
  --data-urlencode "userId=[YOUR_USER_ID]"

{
  "id": "664f1a2b3c4d5e6f7a8b9c0d",
  "name": "Showroom Demo",
  "region": "us-east-1",
  "status": "active",
  "webhookUrl": "https://hooks.example.com/streampixel",
  "webhookEvents": [
    "build.approved",
    "build.rejected",
    "build.distributing"
  ],
  "customDomain": "stream.example.com",
  "files": [
    {
      "_id": "665a2b3c4d5e6f7a8b9c0e1f",
      "url": "https://your-bucket.s3.amazonaws.com/builds/v1.2.0.zip",
      "status": "Approved",
      "date": "2026-04-30T19:00:00.000Z",
      "objection": null
    },
    {
      "_id": "665a2b3c4d5e6f7a8b9c0e20",
      "url": "https://your-bucket.s3.amazonaws.com/builds/v1.1.9.zip",
      "status": "Reject",
      "date": "2026-04-21T11:30:00.000Z",
      "objection": "Build contains unsupported file formats."
    }
  ],
  "liveUsers": 12,
  "usersInQueue": 0,
  "subscriptionStatus": "active",
  "createdAt": "2026-02-01T10:15:00.000Z",
  "updatedAt": "2026-04-30T19:11:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

Fetch the complete configuration, build history, and live status for a single project. This is the endpoint backing the dashboard’s project detail page — useful for support tooling, deploy dashboards, and any automation that needs the full project shape rather than the summary returned by List Projects.

​
Typical workflow

1

Resolve a project ID

Discover it from List Projects or from the dashboard URL.
2

Call this endpoint

GET /projects/{id}?userId={userId}.
3

Use the response

Inspect the build list, current status, webhook config, or live user counts as needed.

​
Prerequisites

RequirementWhere to get it
User IDFinding your IDs
Project IDFinding your IDs
API KeyAPI authentication (recommended for server-side clients)

​
Path parameter

​
id
string
required
The project ID to fetch.

​
Query parameter

​
userId
string
required
The ID of the account that owns the project. Used for authorization.

​
Response

A single project object with the following fields:
​
id
string
Unique project identifier.
​
name
string
Display name of the project.
​
region
string
Region the project’s streaming infrastructure is deployed to (e.g., us-east-1).
​
status
string
Current high-level project state (e.g., active, paused).
​
webhookUrl
string | null
Configured webhook destination URL, or null if none is set.
​
webhookEvents
string[]
List of subscribed event names (e.g., ["build.approved", "build.rejected"]). Empty array means no events are subscribed.
​
customDomain
string | null
Custom domain currently bound to this project, or null if none is configured.
​
files
array
Build history for the project. Each item describes one uploaded build.
​
liveUsers
number
Number of users currently streaming the project.
​
usersInQueue
number
Number of users waiting in the queue.
​
subscriptionStatus
string
Billing state of the project’s subscription (e.g., active, trialing, past_due).
​
createdAt
string
ISO 8601 timestamp of project creation.
​
updatedAt
string
ISO 8601 timestamp of the most recent update.
curl -G https://api.streampixel.io/pixelStripeApi/projects/[YOUR_PROJECT_ID] \
  --data-urlencode "userId=[YOUR_USER_ID]"

{
  "id": "664f1a2b3c4d5e6f7a8b9c0d",
  "name": "Showroom Demo",
  "region": "us-east-1",
  "status": "active",
  "webhookUrl": "https://hooks.example.com/streampixel",
  "webhookEvents": [
    "build.approved",
    "build.rejected",
    "build.distributing"
  ],
  "customDomain": "stream.example.com",
  "files": [
    {
      "_id": "665a2b3c4d5e6f7a8b9c0e1f",
      "url": "https://your-bucket.s3.amazonaws.com/builds/v1.2.0.zip",
      "status": "Approved",
      "date": "2026-04-30T19:00:00.000Z",
      "objection": null
    },
    {
      "_id": "665a2b3c4d5e6f7a8b9c0e20",
      "url": "https://your-bucket.s3.amazonaws.com/builds/v1.1.9.zip",
      "status": "Reject",
      "date": "2026-04-21T11:30:00.000Z",
      "objection": "Build contains unsupported file formats."
    }
  ],
  "liveUsers": 12,
  "usersInQueue": 0,
  "subscriptionStatus": "active",
  "createdAt": "2026-02-01T10:15:00.000Z",
  "updatedAt": "2026-04-30T19:11:00.000Z"
}

​
Working with the build list

The files array is returned in upload order. To find the currently live build, look for the most recent entry with status: "Approved":
Node.js
const latestApproved = project.files
  .filter((b) => b.status === 'Approved')
  .sort((a, b) => new Date(b.date) - new Date(a.date))[0];

console.log('Live build:', latestApproved?._id);
Use webhook events (build.approved) instead of polling this endpoint for build state changes. Polling is fine for ad-hoc inspection, not for production state machines.

​
Next steps

Live Stats

Get real-time live and queued user counts without fetching the full project object.

Distribute File API

Push a specific build from the files array to streaming servers.