Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/pixiebrix-support-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no email required.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: PixieBrix Support API
version: 1.0.0
description: PixieBrix admin and package registry API
contact:
name: PixieBrix Support
email: support@pixiebrix.com
servers:
- url: https://app.pixiebrix.com
tags:
- name: support
paths:
/api/support/users/:
get:
operationId: listSupportUsers
description: 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.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: q
required: false
in: query
description: A search term.
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportUserDetail'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportUserDetail'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/users/>; rel="first", <https://app.pixiebrix.com/support/users/?page=3>; rel="prev", <https://app.pixiebrix.com/support/users/?page=5>; rel="next", <https://app.pixiebrix.com/support/users/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/users/{id}/:
get:
operationId: retrieveSupportUsers
description: Return a single user's profile and the active teams they belong to for support investigation.
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: q
required: false
in: query
description: A search term.
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
$ref: '#/components/schemas/SupportUserDetail'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
$ref: '#/components/schemas/SupportUserDetail'
description: ''
tags:
- support
/api/support/users/{user_pk}/events/:
get:
operationId: retrieveSupportUserEvents
description: Return the recent product-usage and telemetry events recorded for a single user, for support investigation.
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=1.0:
schema:
$ref: '#/components/schemas/SupportUserEvent'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
$ref: '#/components/schemas/SupportUserEvent'
description: ''
tags:
- support
/api/support/users/{user_pk}/errors/:
get:
operationId: listUserErrors
description: Return recent error telemetry recorded for a single user, newest first.
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/UserErrorItem'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/UserErrorItem'
description: ''
tags:
- support
/api/support/deployments/{deployment_pk}/errors/:
get:
operationId: listSupportDeploymentErrors
description: Support console view for retrieving errors for any deployment.
parameters:
- name: deployment_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ErrorItemGroup'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ErrorItemGroup'
description: ''
tags:
- support
/api/support/users/{user_pk}/bricks/:
get:
operationId: listSupportUserBricks
description: List the packages authored by a single user that are visible to that user, for support investigation.
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Package'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/Package'
description: ''
tags:
- support
/api/support/users/{user_pk}/bricks/{brick_pk}/:
get:
operationId: retrieveSupportUserBricks
description: Return a single package authored by and visible to a user, for support investigation.
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: brick_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=1.0:
schema:
$ref: '#/components/schemas/Package'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
$ref: '#/components/schemas/Package'
description: ''
tags:
- support
/api/support/users/{user_pk}/flags/:
get:
operationId: listSupportUserFlags
description: Return the effective feature flags for a support user.
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportUserFlag'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportUserFlag'
description: ''
tags:
- support
/api/support/mod-copilot-sessions/:
get:
operationId: listSupportConsoleModCopilotSessions
description: Support console view for listing and retrieving Mod Copilot Sessions.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/ModCopilotSession'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/ModCopilotSession'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/mod-copilot-sessions/>; rel="first", <https://app.pixiebrix.com/support/mod-copilot-sessions/?page=3>; rel="prev", <https://app.pixiebrix.com/support/mod-copilot-sessions/?page=5>; rel="next", <https://app.pixiebrix.com/support/mod-copilot-sessions/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/mod-copilot-sessions/{id}/:
get:
operationId: retrieveSupportConsoleModCopilotSessions
description: Support console view for listing and retrieving Mod Copilot Sessions.
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
$ref: '#/components/schemas/ModCopilotSession'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
$ref: '#/components/schemas/ModCopilotSession'
description: ''
tags:
- support
/api/support/token/:
get:
operationId: listSupportAgents
description: API tokens that support agents use to call the Support Console API on a staff member's behalf.
parameters: []
responses:
'200':
content:
application/json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportServiceAccountSummary'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportServiceAccountSummary'
description: ''
tags:
- support
post:
operationId: createSupportAgent
description: API tokens that support agents use to call the Support Console API on a staff member's behalf.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SupportServiceAccountWithToken'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SupportServiceAccountWithToken'
multipart/form-data:
schema:
$ref: '#/components/schemas/SupportServiceAccountWithToken'
responses:
'201':
content:
application/json; version=1.0:
schema:
$ref: '#/components/schemas/SupportServiceAccountWithToken'
application/vnd.pixiebrix.api+json; version=1.0:
schema:
$ref: '#/components/schemas/SupportServiceAccountWithToken'
description: ''
tags:
- support
/api/support/organizations/:
get:
operationId: listSupportOrganizations
description: "Search and retrieve organizations for support investigation.\n\nUse this when a ticket quotes a team name or scope but not a user.\n\n- ``?scope=@acme`` — exact-match lookup against the unique ``scope`` field.\n Prefer when the scope is known; returns at most one row.\n- ``?q=...`` — fuzzy ``icontains`` over both ``name`` and ``scope``. Use\n when you only have a partial or display-name hint."
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: scope
required: false
in: query
description: Optional. Exact-match team scope (e.g. ``@acme``). Scopes are unique, so this returns at most one row — prefer over ``q`` when the scope is known.
schema:
type: string
- name: q
required: false
in: query
description: A search term.
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportOrganization'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportOrganization'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/organizations/>; rel="first", <https://app.pixiebrix.com/support/organizations/?page=3>; rel="prev", <https://app.pixiebrix.com/support/organizations/?page=5>; rel="next", <https://app.pixiebrix.com/support/organizations/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/organizations/{id}/:
get:
operationId: retrieveSupportOrganizations
description: "Search and retrieve organizations for support investigation.\n\nUse this when a ticket quotes a team name or scope but not a user.\n\n- ``?scope=@acme`` — exact-match lookup against the unique ``scope`` field.\n Prefer when the scope is known; returns at most one row.\n- ``?q=...`` — fuzzy ``icontains`` over both ``name`` and ``scope``. Use\n when you only have a partial or display-name hint."
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
$ref: '#/components/schemas/SupportOrganization'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
$ref: '#/components/schemas/SupportOrganization'
description: ''
tags:
- support
/api/support/organizations/{org_pk}/groups/:
get:
operationId: listSupportOrganizationGroups
description: 'List an organization''s groups for support investigation.
Lets a consumer find a group by name (and gauge its size via
``member_count``) without first locating a deployment that targets it.'
parameters:
- name: org_pk
in: path
required: true
description: ''
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportGroup'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportGroup'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/organizations/{org_pk}/groups/>; rel="first", <https://app.pixiebrix.com/support/organizations/{org_pk}/groups/?page=3>; rel="prev", <https://app.pixiebrix.com/support/organizations/{org_pk}/groups/?page=5>; rel="next", <https://app.pixiebrix.com/support/organizations/{org_pk}/groups/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/groups/{group_pk}/members/:
get:
operationId: listSupportGroupMembers
description: '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 instead of guessing
email patterns. ``?q=`` does an ``icontains`` over first name, last name,
and email. Soft-deleted (removed) memberships are excluded.'
parameters:
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: q
required: false
in: query
description: A search term.
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportUserDetail'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportUserDetail'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/groups/{group_pk}/members/>; rel="first", <https://app.pixiebrix.com/support/groups/{group_pk}/members/?page=3>; rel="prev", <https://app.pixiebrix.com/support/groups/{group_pk}/members/?page=5>; rel="next", <https://app.pixiebrix.com/support/groups/{group_pk}/members/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/organizations/{org_pk}/activity-policies/:
get:
operationId: listSupportOrganizationActivityPolicies
description: '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/version of
policies in the field without going through the org-scoped product API.
Use ``/api/support/activity-policies/<id>/`` for one policy''s full config.
Not gated by the activity-tracking flag — support can inspect a policy even
after the flag is toggled off.'
parameters:
- name: org_pk
in: path
required: true
description: ''
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportActivityPolicyList'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportActivityPolicyList'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/organizations/{org_pk}/activity-policies/>; rel="first", <https://app.pixiebrix.com/support/organizations/{org_pk}/activity-policies/?page=3>; rel="prev", <https://app.pixiebrix.com/support/organizations/{org_pk}/activity-policies/?page=5>; rel="next", <https://app.pixiebrix.com/support/organizations/{org_pk}/activity-policies/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/activity-policies/{id}/:
get:
operationId: retrieveSupportActivityPolicies
description: '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.'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
$ref: '#/components/schemas/SupportActivityPolicyDetail'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
$ref: '#/components/schemas/SupportActivityPolicyDetail'
description: ''
tags:
- support
/api/support/users/{user_pk}/activity-policies/:
get:
operationId: listSupportUserActivityPolicies
description: '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 on a user id for support
triage — each row carries the policy''s ``assigned_groups`` (all groups it''s
assigned to) and ``matching_groups`` (the subset the user belongs to that
make it apply). Spans every organization the user has an applicable policy
in; ``organization`` on each row disambiguates. Soft-deleted memberships are
excluded (``group_ids`` reflects active memberships only).'
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportMemberActivityPolicy'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportMemberActivityPolicy'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/users/{user_pk}/activity-policies/>; rel="first", <https://app.pixiebrix.com/support/users/{user_pk}/activity-policies/?page=3>; rel="prev", <https://app.pixiebrix.com/support/users/{user_pk}/activity-policies/?page=5>; rel="next", <https://app.pixiebrix.com/support/users/{user_pk}/activity-policies/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/deployments/:
get:
operationId: listSupportDeployments
description: 'Search and retrieve organization deployments for support investigation.
List requires ``?organization=<id>`` and supports ``?q=<name>`` (icontains
on deployment name) and ``?active=true|false``.
Retrieve returns the current ``options_config``, the resolved package
version, effective deployment-level bindings, target platforms, and the
user groups the deployment targets. Use ``/audit/`` for prior values.'
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: organization
required: true
in: query
description: Required. Organization id whose deployments to list.
schema:
type: string
- name: active
required: false
in: query
description: Optional. Filter to active (true) or paused (false) deployments.
schema:
type: string
- name: q
required: false
in: query
description: A search term.
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportDeploymentList'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/SupportDeploymentList'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/deployments/>; rel="first", <https://app.pixiebrix.com/support/deployments/?page=3>; rel="prev", <https://app.pixiebrix.com/support/deployments/?page=5>; rel="next", <https://app.pixiebrix.com/support/deployments/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/deployments/{id}/:
get:
operationId: retrieveSupportDeployments
description: 'Search and retrieve organization deployments for support investigation.
List requires ``?organization=<id>`` and supports ``?q=<name>`` (icontains
on deployment name) and ``?active=true|false``.
Retrieve returns the current ``options_config``, the resolved package
version, effective deployment-level bindings, target platforms, and the
user groups the deployment targets. Use ``/audit/`` for prior values.'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json; version=2.0:
schema:
$ref: '#/components/schemas/SupportDeploymentDetail'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
$ref: '#/components/schemas/SupportDeploymentDetail'
description: ''
tags:
- support
/api/support/deployments/{deployment_pk}/audit/:
get:
operationId: listSupportDeploymentAudits
description: 'Audit history for a single deployment, for support investigation.
Returns the same ``AuditEvent`` rows as ``/api/audit/deployments/<pk>/``
but is accessible to Support group members rather than only organization
managers/admins. Each event''s ``data`` includes the deployment name, mod
registry id + version, active flag, options_config, integration
configurations, and platforms at the time of the change — see
``api/audit/signals.py:deployment_save``.'
parameters:
- name: deployment_pk
in: path
required: true
description: ''
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/AuditEvent'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/AuditEvent'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/deployments/{deployment_pk}/audit/>; rel="first", <https://app.pixiebrix.com/support/deployments/{deployment_pk}/audit/?page=3>; rel="prev", <https://app.pixiebrix.com/support/deployments/{deployment_pk}/audit/?page=5>; rel="next", <https://app.pixiebrix.com/support/deployments/{deployment_pk}/audit/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- support
/api/support/databases/{database_pk}/records/:
get:
operationId: listSupportDatabaseRecords
description: "List records in a team database for support investigation.\n\nRestricted to organization-owned (team) databases. Supports the same\nrecord-level filters as ``/api/databases/{database_pk}/records/``:\n\n- ``?start_date=YYYY-MM-DD`` / ``?end_date=YYYY-MM-DD`` filter on\n ``created_at`` (inclusive on both sides).\n- ``?data__email=user@example.com`` (and other ``?data__*=`` filters)\n query the record JSON; ``data__email`` is indexed.\n\nThe shared ``max_record_count = 10_000`` guard enforced by\n``PaginatedListAPIView`` is reused — callers must paginate or filter."
parameters:
- name: database_pk
in: path
required: true
description: ''
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
responses:
'200':
content:
application/json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/Record'
application/vnd.pixiebrix.api+json; version=2.0:
schema:
type: array
items:
$ref: '#/components/schemas/Record'
description: ''
headers:
Link:
schema:
type: string
example: '<https://app.pixiebrix.com/support/databases/{database_pk}/records/>; rel="first", <https://app.pixiebrix.com/support/databases/{database_pk}/records/?page=3>; rel="prev", <https://app.pixiebrix.com/support/databases/{database_pk}/records/?page=5>; rel="next", <https://app.pixiebrix.com/support/databases/{database_pk}/records/?page=11>; rel="last"'
description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
tags:
- suppo
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/openapi/pixiebrix-support-api-openapi.yml