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

PixieBrix Organizations API

The organizations API from PixieBrix — 42 operation(s) for organizations.

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

Tagged areas include Organization. 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 70 operations across 42 paths, and defines 32 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.

70 operations 42 paths 32 schemas 9 DELETE39 GET5 PATCH11 POST6 PUT

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/
Resource Areas
1

Paths & Operations 70

Across 42 paths, the API surfaces 70 operations — 9 DELETE, 39 GET, 5 PATCH, 11 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

organizations 70
GET
/api/organizations/{organization_pk}/campaigns/
Return the campaigns belonging to an organization, ordered by name.
listCampaigns 3 params → 200
POST
/api/organizations/{organization_pk}/campaigns/
Create a new campaign in an organization with the given name.
createCampaign 1 param body → 201
GET
/api/organizations/{organization_pk}/campaigns/{id}/
Return a single campaign in an organization by its id.
retrieveCampaign 2 params → 200
PATCH
/api/organizations/{organization_pk}/campaigns/{id}/
Update selected fields, such as the name, of a campaign in an organization.
partialUpdateCampaign 2 params body → 200
DELETE
/api/organizations/{organization_pk}/campaigns/{id}/
Delete a campaign from an organization.
destroyCampaign 2 params → 204
GET
/api/organizations/{organization_pk}/campaigns/{campaign_pk}/members/
Paginated view of members in a Campaign.
listCampaignMembers 4 params → 200
POST
/api/organizations/{organization_pk}/campaigns/{campaign_pk}/members/
Paginated view of members in a Campaign.
createCampaignMember 2 params body → 201
PUT
/api/organizations/{organization_pk}/campaigns/{campaign_pk}/members/
Paginated view of members in a Campaign.
updateCampaignMember 2 params body → 200
GET
/api/organizations/{organization_pk}/invitations/
Return the pending membership invitations for a team, including each invitee's email, role, and the inviter.
listOrganizationInvitations 3 params → 200
POST
/api/organizations/{organization_pk}/invitations/
Invite one or more people to join a team by email and assigned role, creating pending invitations.
createOrganizationInvitation 1 param body → 201
GET
/api/organizations/
Return the teams (organizations) the current user belongs to, including the user's membership details for each.
listOrganizations 2 params → 200
POST
/api/organizations/
Create a new team (organization).
createOrganization body → 201
GET
/api/organizations/{organization_pk}/
Return a single team (organization) the current user belongs to by id.
retrieveOrganization 1 param → 200
PATCH
/api/organizations/{organization_pk}/
Update selected fields on a team (organization).
partialUpdateOrganization 1 param body → 200
DELETE
/api/organizations/{organization_pk}/
Delete a team (organization); deletion is blocked for teams with packages, an active subscription, or enterprise status.
destroyOrganization 1 param → 204
GET
/api/organizations/{organization_pk}/members/{id}/
Return detailed information for a single member of the team, including their group memberships.
retrieveUserDetail 2 params → 200
GET
/api/organizations/{organization_pk}/members/{user_pk}/extensions/
Return the browser extensions most recently reported installed on a team member's device(s), newest first.
listUserInstalledExtensions 2 params → 200
GET
/api/organizations/{organization_pk}/members/{user_pk}/deployments/
Return every deployment assigned to a team member (via direct assignment or group membership), annotated with whether each is the effective deployment, paused, or superseded by a higher-precedence de…
listMemberDeployments 2 params → 200
GET
/api/organizations/{organization_pk}/extensions/
Return the distinct browser extensions reported across the organization's members, aggregated per extension with a distinct-member count and install-type breakdown. Unmanaged extensions are listed fi…
listOrganizationInstalledExtensions 1 param → 200
GET
/api/organizations/{organization_pk}/serviceaccounts/
Return the service accounts (non-human team members used for automation) belonging to an organization, including each account's label, role, and activity timestamps.
listServiceAccounts 3 params → 200
POST
/api/organizations/{organization_pk}/serviceaccounts/
Create a new service account in an organization with the given label and role, and return it together with a one-time API token for authenticating as that account.
createServiceAccountWithToken 1 param body → 201
GET
/api/organizations/{organization_pk}/serviceaccounts/{id}/
Return a single service account in an organization, including its label, role, and activity timestamps.
retrieveServiceAccount 2 params → 200
DELETE
/api/organizations/{organization_pk}/serviceaccounts/{id}/
Remove a service account from an organization, revoking its access and API token.
destroyServiceAccount 2 params → 204
GET
/api/organizations/{organization_pk}/deployment-keys/
Return the deployment keys for an organization, each with its label and authentication token.
listDeploymentKeys 3 params → 200
POST
/api/organizations/{organization_pk}/deployment-keys/
Create a deployment key for an organization from the provided label and return it with its newly issued authentication token.
createDeploymentKey 1 param body → 201
GET
/api/organizations/{organization_pk}/deployment-keys/{id}/
Return a single deployment key for an organization, including its label and authentication token.
retrieveDeploymentKey 2 params → 200
DELETE
/api/organizations/{organization_pk}/deployment-keys/{id}/
Delete a deployment key from an organization, revoking its authentication token.
destroyDeploymentKey 2 params → 204
GET
/api/organizations/{organization_pk}/groups/
Return the team's groups, each annotated with its member count, ordered by name.
listGroups 3 params → 200
POST
/api/organizations/{organization_pk}/groups/
Create a new group within the team.
createGroup 1 param body → 201
GET
/api/organizations/{organization_pk}/deployments/
View for admins to list/create deployments.
listDeployments 3 params → 200
POST
/api/organizations/{organization_pk}/deployments/
View for admins to list/create deployments.
createDeployment 1 param body → 201
GET
/api/organizations/{organization_pk}/bricks/
Return the packages (bricks) visible to the team, including private packages shared with it, searchable by name.
listOrganizationBricks 4 params → 200
GET
/api/organizations/{organization_pk}/blueprints/
Return the mod versions available for an organization to deploy.
listOrganizationBlueprints 3 params → 200
GET
/api/organizations/{organization_pk}/blueprints/{id}/
Return a single mod version available for an organization to deploy.
retrieveOrganizationBlueprints 2 params → 200
GET
/api/organizations/{organization_pk}/integrations/
Return the team's shared integration configurations (metadata only, without secrets), searchable by label or integration name.
listServiceAuthMeta 4 params → 200
GET
/api/organizations/{organization_pk}/memberships/
List view of an organization's memberships.
listMemberships 10 params → 200
GET
/api/organizations/{organization_pk}/databases/{id}/
Return a single database belonging to the specified organization, including its name, type, and record statistics.
retrieveDatabase 3 params → 200
PUT
/api/organizations/{organization_pk}/databases/{id}/
Replace all editable fields of a database owned by the specified organization.
updateDatabase 3 params body → 200
PATCH
/api/organizations/{organization_pk}/databases/{id}/
Update selected fields of a database owned by the specified organization.
partialUpdateDatabase 3 params body → 200
DELETE
/api/organizations/{organization_pk}/databases/{id}/
Permanently delete a database, and all of its records, from the specified organization.
destroyDatabase 3 params → 204
GET
/api/organizations/{organization_pk}/databases/{database_pk}/schema/
Return the stored JSON Schema for a database's records, or a schema inferred from recent records when the method query parameter is set to infer.
retrieveDatabaseSchema 2 params → 200
PUT
/api/organizations/{organization_pk}/databases/{database_pk}/schema/
Replace the stored JSON Schema that describes the structure of a database's records.
updateDatabaseSchema 2 params body → 200
GET
/api/organizations/{organization_pk}/databases/{database_pk}/record-archives/
List the archived snapshots of a team database's records, newest first, each with a downloadable file capturing the database contents at the time it was archived.
listDatabaseRecordsArchives 5 params → 200
GET
/api/organizations/{organization_pk}/databases/
Return the databases owned by the specified organization that the caller is allowed to manage.
listDatabases 4 params → 200
POST
/api/organizations/{organization_pk}/databases/
Create a new database owned by the specified organization.
createDatabase 1 param body → 201
GET
/api/organizations/{organization_pk}/subscriptions/
Return the subscriptions for an organization, including each subscription's seat pricing, session-hour limits, and recent daily seat-utilization history.
listSubscriptions 1 param → 200
GET
/api/organizations/{organization_pk}/backup/
Return a JSON snapshot of an organization's data for backup, including its members, memberships, groups, contacts, integration configurations, packages and package versions, and deployments.
exportOrganizationBackup 1 param → 200
GET
/api/organizations/{organization_pk}/errors/
Return recent error telemetry for an organization, grouped by error and limited to the deployments the requesting manager can access.
listOrganizationErrors 1 param → 200
GET
/api/organizations/{organization_pk}/events/
List per-deployment event counts over time for the organization's visible deployments, with each entry reporting the number of events recorded for a deployment within an interval ending at a given ti…
listEventIntervals 1 param → 200
GET
/api/organizations/{organization_pk}/contacts/
Return the organization's notification contacts (email recipients alerted when a new user joins or when a deployment reports new errors), sorted by email.
listOrganizationContacts 3 params → 200
POST
/api/organizations/{organization_pk}/contacts/
Add a notification contact to the organization, including which alerts (new user joins, deployment errors) it should receive.
createOrganizationContact 1 param body → 201
GET
/api/organizations/{organization_pk}/contacts/{id}/
Return a single notification contact for the organization by id.
retrieveOrganizationContact 2 params → 200
PUT
/api/organizations/{organization_pk}/contacts/{id}/
Replace all fields of an existing organization notification contact.
updateOrganizationContact 2 params body → 200
PATCH
/api/organizations/{organization_pk}/contacts/{id}/
Update selected fields of an existing organization notification contact.
partialUpdateOrganizationContact 2 params body → 200
DELETE
/api/organizations/{organization_pk}/contacts/{id}/
Remove a notification contact from the organization.
destroyOrganizationContact 2 params → 204
GET
/api/organizations/{organization_pk}/assets/
Return the static file assets belonging to an organization, oldest first, each including its file name, type, and most recent version.
listStaticAssets 3 params → 200
GET
/api/organizations/{organization_pk}/assets/{id}/
Return a single static file asset for an organization, including its file name, type, and most recent version.
retrieveStaticAsset 2 params → 200
GET
/api/organizations/{organization_pk}/assets/{id}/upload/
Get pre-signed URL to update the S3 bucket with the asset.
uploadStaticAssetUploadUrl 2 params → 200
GET
/api/organizations/{organization_pk}/assets/{id}/versions/
Return the version history for a static file asset in an organization.
listStaticAssetVersions 2 params → 200
POST
/api/organizations/{organization_pk}/assets/{id}/versions/
Record a new version of a static file asset in an organization after the underlying file has been uploaded.
createStaticAssetVersion 2 params body → 201
GET
/api/organizations/{organization_pk}/auth-url-patterns/
Return the URL patterns that automatically log the team's members into the extension on matching pages.
listOrganizationAuthUrlPatterns 1 param → 200
PUT
/api/organizations/{organization_pk}/auth-url-patterns/
Replace the team's entire set of automatic-login URL patterns with the provided list.
updateOrganizationAuthUrlPatterns 1 param body → 200
GET
/api/organizations/{organization_pk}/extension-deny-patterns/
Return the URL patterns on which the extension is disabled for the team's members.
listOrganizationExtensionDenyPatterns 1 param → 200
PUT
/api/organizations/{organization_pk}/extension-deny-patterns/
Replace the team's entire set of extension deny patterns with the provided list.
updateOrganizationExtensionDenyPatterns 1 param body → 200
GET
/api/organizations/{organization_pk}/theme/
Return the team's branding theme (logo and colors) used to customize the extension's appearance.
retrieveOrganizationTheme 1 param → 200
PATCH
/api/organizations/{organization_pk}/theme/
Update selected fields of the team's branding theme.
partialUpdateOrganizationTheme 1 param body → 200
GET
/api/organizations/{organization_pk}/report/
Return a signed URL for embedding the organization's analytics report dashboard, accessible only to its managers and admins.
retrieveOrganizationReport 1 param → 200
DELETE
/api/organizations/{organization_pk}/invitations/{id}/
Revoke a single pending team invitation by id so the invitee can no longer accept it.
destroyOrganizationInvitation 2 params → 204
DELETE
/api/organizations/{organization_pk}/members/{id}/cache/
Clear the cached user permissions for a member of the organization. Used by team admins to force a member's device to refetch up-to-date settings/content on the next request, instead of waiting for t…
destroyOrganizationMemberCache 2 params → 204
DELETE
/api/organizations/{organization_pk}/me/tour-runs/
Delete all of the current user's tour runs within the specified organization.
destroyTourRun 1 param → 204

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Deployment (14 properties), ErrorItemGroup (13 properties), Organization (11 properties), CampaignMember (10 properties). Each schema is shown below with its type and property counts.

ServiceAuthMeta
object
4 properties 2 required
OrganizationInstalledExtension
object
7 properties 7 required
ServiceAccountWithToken
object
6 properties 1 required
PackageMeta
object
7 properties 3 required
DatabaseRecordsArchive
object
6 properties 3 required
Database
object
10 properties 1 required
OrganizationTheme
object
5 properties 1 required
StaticAssetVersion
object
3 properties 1 required
OrganizationAuthUrlPattern
object
1 property 1 required
OrganizationContact
object
6 properties 1 required
Campaign
object
4 properties 1 required
DeploymentKey
object
4 properties 1 required
StaticAsset
object
5 properties 2 required
PackageVersionHeavy
object
8 properties 4 required
Group
object
4 properties 1 required
EventInterval
object
3 properties 3 required
UserDetail
object
8 properties 1 required
PendingInvitation
object
5 properties 1 required
Subscription
object
8 properties 2 required
DatabaseSchema
object
2 properties 1 required
MemberDeployment
object
6 properties
StaticAssetUploadUrl
object
1 property 1 required
ServiceAccount
object
5 properties 1 required
Membership
object
6 properties 1 required
CampaignMember
object
10 properties 2 required
Organization
object
11 properties 1 required
ErrorItemGroup
object
13 properties 10 required
Deployment
object
14 properties 3 required
OrganizationExtensionDenyPattern
object
1 property 1 required
UserBrowserExtension
object
9 properties 6 required
OrganizationReport
object
1 property 1 required
DeploymentTelemetry
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-organizations-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
PixieBrix Audit API
PixieBrix Bricks API
PixieBrix Campaigns API
PixieBrix Config API
PixieBrix Control Rooms API
PixieBrix Copilot API
PixieBrix Databases API
PixieBrix Deployments API
PixieBrix Events API
PixieBrix Groups API
PixieBrix Health API
Where this information came from

This is an independent, third-party profile of PixieBrix Organizations 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.