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 Groups API

The groups API from PixieBrix — 9 operation(s) for groups.

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

Tagged areas include Group. 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 22 operations across 9 paths, and defines 6 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.

22 operations 9 paths 6 schemas 4 DELETE8 GET3 PATCH4 POST3 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 22

Across 9 paths, the API surfaces 22 operations — 4 DELETE, 8 GET, 3 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

groups 22
GET
/api/groups/{group_pk}/memberships/
Add, remove, and list users to/from a group
listGroupMemberships 3 params → 200
POST
/api/groups/{group_pk}/memberships/
Add, remove, and list users to/from a group
createGroupMembership 1 param body → 201
PUT
/api/groups/{group_pk}/memberships/
Add, remove, and list users to/from a group
updateGroupMembership 2 params body → 200
GET
/api/groups/{id}/permissions/
Return the package permissions granted to a group, listing which packages the group can access.
listGroupPackagePermissions 3 params → 200
POST
/api/groups/{id}/permissions/
Grant a group access to one or more packages, optionally including their dependencies.
createGroupPackagePermission 1 param body → 201
GET
/api/groups/{id}/integrations/
Return the integration configurations a group has been granted access to.
listServiceAuthPermissions 3 params → 200
POST
/api/groups/{id}/integrations/
Grant a group access to one or more of the team's shared integration configurations.
createServiceAuthPermission 1 param body → 201
GET
/api/groups/{group_pk}/integrations/{id}/
Return a single group integration permission by id.
retrieveServiceAuthPermission 2 params → 200
PUT
/api/groups/{group_pk}/integrations/{id}/
Replace a group integration permission by id.
updateServiceAuthPermission 2 params body → 200
PATCH
/api/groups/{group_pk}/integrations/{id}/
Update selected fields of a group integration permission by id.
partialUpdateServiceAuthPermission 2 params body → 200
DELETE
/api/groups/{group_pk}/integrations/{id}/
Revoke a group's access to an integration configuration by id.
destroyServiceAuthPermission 2 params → 204
GET
/api/groups/{id}/
Return a single group by id, including its deployments.
retrieveGroup 1 param → 200
PUT
/api/groups/{id}/
Replace a group by id.
updateGroup 1 param body → 200
PATCH
/api/groups/{id}/
Update selected fields of a group by id.
partialUpdateGroup 1 param body → 200
DELETE
/api/groups/{id}/
Delete a group by id.
destroyGroup 1 param → 204
GET
/api/groups/{group_pk}/databases/
Return the database permissions granted to a group, listing which databases the group can access.
listDatabasePermissions 3 params → 200
POST
/api/groups/{group_pk}/databases/
Grant a group access to one or more databases.
createList 1 param body → 201
GET
/api/groups/{group_pk}/databases/{id}/
Return a single group database permission by id.
retrieveDatabasePermission 2 params → 200
PATCH
/api/groups/{group_pk}/databases/{id}/
Update selected fields of a group database permission by id.
partialUpdateDatabasePermission 2 params body → 200
DELETE
/api/groups/{group_pk}/databases/{id}/
Revoke a group's access to a database by id.
destroyDatabasePermission 2 params → 204
GET
/api/groups/{group_pk}/errors/
Return recent error telemetry for the members of a team group, grouped by error.
listGroupErrors 1 param → 200
DELETE
/api/groups/{group_pk}/memberships/{id}/
Add, remove, and list users to/from a group
destroyGroupMembership 2 params → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ErrorItemGroup (13 properties), GroupMembership (7 properties), DatabasePermission (5 properties), ServiceAuthPermission (5 properties). Each schema is shown below with its type and property counts.

ServiceAuthPermission
object
5 properties 2 required
ErrorItemGroup
object
13 properties 10 required
GroupPackagePermission
object
4 properties 1 required
GroupDetail
object
4 properties 1 required
GroupMembership
object
7 properties
DatabasePermission
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-groups-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 Health API
PixieBrix Identify API
Where this information came from

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