Team Management APIs
PixieBrix Team Management APIs Overviews
Last updated
PixieBrix Team Management APIs Overviews
Last updated
This page details the most import APIs for team management, e.g., integration with a workforce management (WFM) system or identity provider. For a complete list of team management API endpoints, see OpenAPI Specification
GET /api/organizations/:organizationId/memberships/
This endpoint must be paginated, see .
Service accounts are included by default. To exclude them, use the following param: user__service_account=true
Deployment key accounts are included by default. To exclude them, use the following param: user__deployment_key_account=true
GET /api/organizations/:organizationId/groups/
POST /api/organizations/:organizationId/groups/
The payload should include the group name. For example:
To get the current memberships:
GET /api/groups/:groupId/memberships/
POST /api/groups/:groupId/memberships/
: Add one or more members to a Group
PUT /api/groups/:groupId/memberships/
: Replace the members in a Group
When using the PUT
method, the members you provide will replace the current membership list. Existing members that are not in the payload will be removed from the group.
The payload should consist of one or more registered user ids or emails.
To include an email, the user must be either: 1) already a member of your team, or 2) have an email domain that has been verified for your team. To verify an email domain for your team, contact [email protected].
Example payload:
To delete a single group membership, call the DELETE method on the membership resource.
DELETE /api/groups/:groupId/memberships/:membershipId/
GET /api/organizations/:organizationId/campaigns/
To update a campaign's name, use the following endpoint:
GET /api/organizations/:organizationId/campaigns/:campaignId/
Example payload:
To list membership information for a given campaign, use the following endpoint:
GET /api/organizations/:organizationId/campaigns/:campaignId/members/
POST /api/organizations/:organizationId/campaigns/:campaignId/members/
: Add one or more members to a Campaign
PUT /api/organizations/:organizationId/campaigns/:campaignId/members/
: Replace the members in a Campaign
When using the PUT
method, the members you provide will replace the current membership list. Existing members that are not in the payload will be removed from the campaign.
To include an email, the user must be either: 1) already a member of your team, or 2) have an email domain that’s been verified for your team. To verify an email domain for your team, contact [email protected]
The users list supports a data
property where you can provide custom master data about the users for reporting, e.g., Location, Organization Unit, etc.
Example payload: