Skip to main content
GET
/
pixelStripeApi
/
projects
/
projects-status
curl -G https://api.streampixel.io/pixelStripeApi/projects/projects-status \
  --data-urlencode "userId=[YOUR_USER_ID]" \
  --data-urlencode "apikey=[YOUR_API_KEY]"

{
  "totalProjects": 2,
  "projects": [
    {
      "_id": "664f1a2b3c4d5e6f7a8b9c0d",
      "name": "Showroom Demo",
      "status": true,
      "subscriptionStatus": "active"
    },
    {
      "_id": "664f1a2b3c4d5e6f7a8b9c0e",
      "name": "Configurator EU",
      "status": false,
      "subscriptionStatus": "active"
    }
  ]
}

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.

Return a list of all projects owned by the authenticated user, with the basic status of each. Use this to enumerate your projects from a server-side script, CI/CD pipeline, or monitoring job before fanning out to per-project endpoints.

​
Typical workflow

1

Authenticate

Pass userId and apikey as query parameters. Both are required.
2

Request the list

Call GET /projects/projects-status to retrieve every project you own.
3

Use the IDs

Take each project’s _id and pass it anywhere a projectId is required — for example, Project User Stats.

​
Prerequisites

RequirementWhere to get it
User IDFinding your IDs
API KeyAPI authentication
This is a GET request — the API key is passed as the apikey query parameter. Note the all-lowercase casing: it’s apikey, not apiKey. Treat the URL as sensitive: prefer server-side calls and avoid logging it in plain text.

​
Query parameters

​
userId
string
required
The ID of the account whose projects you want to list. Results are scoped to projects owned by this account.
​
apikey
string
required
Your Streampixel API key. Must match the key issued to userId.

​
Response

​
totalProjects
number
The number of projects returned.
​
projects
array
Array of project objects. Each item contains:
curl -G https://api.streampixel.io/pixelStripeApi/projects/projects-status \
  --data-urlencode "userId=[YOUR_USER_ID]" \
  --data-urlencode "apikey=[YOUR_API_KEY]"

{
  "totalProjects": 2,
  "projects": [
    {
      "_id": "664f1a2b3c4d5e6f7a8b9c0d",
      "name": "Showroom Demo",
      "status": true,
      "subscriptionStatus": "active"
    },
    {
      "_id": "664f1a2b3c4d5e6f7a8b9c0e",
      "name": "Configurator EU",
      "status": false,
      "subscriptionStatus": "active"
    }
  ]
}

​
Error reference

StatusMessageCause
400User ID is requiredThe userId query parameter was omitted.
401Invalid UserThe supplied userId doesn’t match any account.
401Unauthorized: Invalid API KeyThe apikey is missing or doesn’t match the user’s current key.
500Internal server errorUnexpected failure. Retry; if it persists, contact support.
Cache the results for a few minutes if you call this repeatedly. Project membership rarely changes minute-to-minute, and avoiding redundant calls keeps you well under fair-use thresholds.

​
Next

Project User Stats

Get live and queued user counts for a project.

Upload File API

Submit builds to a project via the API.