How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PixieBrix

PixieBrix Support API

The support API from PixieBrix — 29 operation(s) for support.

Documentation Provider Profile APIs.io OpenAPI GitHub

PixieBrix Support API is one of 31 APIs that PixieBrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Support. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 30 operations across 29 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.pixiebrix.com.

30 operations 29 paths 24 schemas 2 DELETE25 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.pixiebrix.com/api/
Contact
PixieBrix Support
Resource Areas
1

Paths & Operations 30

Across 29 paths, the API surfaces 30 operations — 2 DELETE, 25 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

support 30
GET
/api/support/users/
Search and list users for support investigation, returning each user's profile and the active teams they belong to; supports searching by first name, last name, or email.
listSupportUsers 3 params → 200
GET
/api/support/users/{id}/
Return a single user's profile and the active teams they belong to for support investigation.
retrieveSupportUsers 2 params → 200
GET
/api/support/users/{user_pk}/events/
Return the recent product-usage and telemetry events recorded for a single user, for support investigation.
retrieveSupportUserEvents 1 param → 200
GET
/api/support/users/{user_pk}/errors/
Return recent error telemetry recorded for a single user, newest first.
listUserErrors 1 param → 200
GET
/api/support/deployments/{deployment_pk}/errors/
Support console view for retrieving errors for any deployment.
listSupportDeploymentErrors 1 param → 200
GET
/api/support/users/{user_pk}/bricks/
List the packages authored by a single user that are visible to that user, for support investigation.
listSupportUserBricks 1 param → 200
GET
/api/support/users/{user_pk}/bricks/{brick_pk}/
Return a single package authored by and visible to a user, for support investigation.
retrieveSupportUserBricks 2 params → 200
GET
/api/support/users/{user_pk}/flags/
Return the effective feature flags for a support user.
listSupportUserFlags 1 param → 200
GET
/api/support/mod-copilot-sessions/
Support console view for listing and retrieving Mod Copilot Sessions.
listSupportConsoleModCopilotSessions 2 params → 200
GET
/api/support/mod-copilot-sessions/{id}/
Support console view for listing and retrieving Mod Copilot Sessions.
retrieveSupportConsoleModCopilotSessions 1 param → 200
GET
/api/support/token/
API tokens that support agents use to call the Support Console API on a staff member's behalf.
listSupportAgents → 200
POST
/api/support/token/
API tokens that support agents use to call the Support Console API on a staff member's behalf.
createSupportAgent body → 201
GET
/api/support/organizations/
Search and retrieve organizations for support investigation. Use this when a ticket quotes a team name or scope but not a user. - ?scope=@acme — exact-match lookup against the unique scope field. Pre…
listSupportOrganizations 4 params → 200
GET
/api/support/organizations/{id}/
Search and retrieve organizations for support investigation. Use this when a ticket quotes a team name or scope but not a user. - ?scope=@acme — exact-match lookup against the unique scope field. Pre…
retrieveSupportOrganizations 1 param → 200
GET
/api/support/organizations/{org_pk}/groups/
List an organization's groups for support investigation. Lets a consumer find a group by name (and gauge its size via membercount) without first locating a deployment that targets it.
listSupportOrganizationGroups 3 params → 200
GET
/api/support/groups/{group_pk}/members/
List the users with an active membership in a group, for support triage. Resolves a group id (e.g. from a deployment's targeted groups) to its roster so diagnostics can be scoped to a known cohort in…
listSupportGroupMembers 4 params → 200
GET
/api/support/organizations/{org_pk}/activity-policies/
List an organization's activity policies for support investigation. Read-only view of the policies authored for an org (id, name, version, assigned groups, timestamps) so support can audit the shape/…
listSupportOrganizationActivityPolicies 3 params → 200
GET
/api/support/activity-policies/{id}/
Retrieve one activity policy's full authored config for support. Returns the config exactly as stored, plus the owning organization and assigned groups. Read-only and support-group gated.
retrieveSupportActivityPolicies 1 param → 200
GET
/api/support/users/{user_pk}/activity-policies/
List the activity policies that apply to a user via their group memberships. Resolves the same "which policies apply to this member" question the Admin Console member-detail screen answers, but keyed…
listSupportUserActivityPolicies 3 params → 200
GET
/api/support/deployments/
Search and retrieve organization deployments for support investigation. List requires ?organization= and supports ?q= (icontains on deployment name) and ?active=true|false. Retrieve returns the curre…
listSupportDeployments 5 params → 200
GET
/api/support/deployments/{id}/
Search and retrieve organization deployments for support investigation. List requires ?organization= and supports ?q= (icontains on deployment name) and ?active=true|false. Retrieve returns the curre…
retrieveSupportDeployments 1 param → 200
GET
/api/support/deployments/{deployment_pk}/audit/
Audit history for a single deployment, for support investigation. Returns the same AuditEvent rows as /api/audit/deployments/ / but is accessible to Support group members rather than only organizatio…
listSupportDeploymentAudits 3 params → 200
GET
/api/support/databases/{database_pk}/records/
List records in a team database for support investigation. Restricted to organization-owned (team) databases. Supports the same record-level filters as /api/databases/{databasepk}/records/: - ?startd…
listSupportDatabaseRecords 3 params → 200
GET
/api/support/packages/
Search and retrieve package definitions for support investigation. List action supports full-text search via ?q= (matched against package name / registry id and verbose name). Retrieve action looks u…
listSupportPackages 7 params → 200
GET
/api/support/packages/{name}/versions/
List versions for a package for support investigation.
listSupportPackageVersions 3 params → 200
GET
/api/support/packages/{name}/
Search and retrieve package definitions for support investigation. List action supports full-text search via ?q= (matched against package name / registry id and verbose name). Retrieve action looks u…
retrieveSupportPackages 2 params → 200
POST
/api/support/users/{id}/activity/seed/
Generate demo activity-tracking data (spans + events) for a single user in one of their organizations, for building Activity Overview demos. The organization must already have the activity-tracking f…
createSupportUserActivitySeed 1 param body → 201
POST
/api/support/mod-copilot-sessions/{id}/feedback/
Support console view for submitting feedback on Mod Copilot Sessions. Any user with Support group membership can submit feedback on any session, regardless of session ownership.
createSupportConsoleModCopilotSessionFeedback 1 param body → 201
DELETE
/api/support/users/{id}/cache/
Invalidate the server-side cache for a single user so their next request reloads fresh data; does not delete the user.
destroyAppUser 1 param → 204
DELETE
/api/support/token/{id}/
API tokens that support agents use to call the Support Console API on a staff member's behalf.
destroySupportAgent 1 param → 204

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Package (14 properties), ErrorItemGroup (13 properties), SupportDeploymentDetail (11 properties), ModCopilotSession (8 properties). Each schema is shown below with its type and property counts.

PackageMeta
object
7 properties 3 required
SupportDeploymentList
object
7 properties 1 required
SupportUserFlag
object
3 properties 3 required
SupportPackageDetail
object
8 properties 2 required
SupportGroup
object
3 properties 1 required
Package
object
14 properties 2 required
SupportActivitySeedResult
object
6 properties 6 required
SupportActivitySeedRequest
object
3 properties 1 required
SupportOrganization
object
8 properties 1 required
UserErrorItem
object
8 properties 2 required
PackageVersionHeavy
object
8 properties 4 required
SupportServiceAccountSummary
object
5 properties
SupportActivityPolicyList
object
6 properties 1 required
AuditEvent
object
7 properties 4 required
SupportActivityPolicyDetail
object
8 properties 1 required
ModCopilotSessionFeedback
object
8 properties 3 required
SupportMemberActivityPolicy
object
8 properties 1 required
SupportUserDetail
object
8 properties 1 required
SupportUserEvent
object
7 properties 3 required
ErrorItemGroup
object
13 properties 10 required
Record
object
4 properties 2 required
ModCopilotSession
object
8 properties 1 required
SupportDeploymentDetail
object
11 properties 1 required
SupportServiceAccountWithToken
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-support-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
AE Profile APIs.io
PixieBrix Audit API
AE Profile APIs.io
PixieBrix Bricks API
AE Profile APIs.io
PixieBrix Campaigns API
AE Profile APIs.io
PixieBrix Config API
AE Profile APIs.io
PixieBrix Control Rooms API
AE Profile APIs.io
PixieBrix Copilot API
AE Profile APIs.io
PixieBrix Databases API
AE Profile APIs.io
PixieBrix Deployments API
AE Profile APIs.io
PixieBrix Events API
AE Profile APIs.io
PixieBrix Groups API
AE Profile APIs.io
PixieBrix Health API
AE Profile APIs.io
#Support
← Back to P APIs
API Details
ID
pixiebrix:pixiebrix-support-api
Base URL
https://app.pixiebrix.com/api/
Docs
https://docs.pixiebrix.com/developer-api
Provider
PixieBrix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pixiebrix-support-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pixiebrix-support-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PixieBrix Support API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.