Team Management APIs

PixieBrix Team Management APIs Overviews

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

Group Management

To retrieve and manage group membership, use the memberships endpoints.

Each group membership has a unique UUID. Use the List Group Memberships endpoint to retrieve the membership identifiers.

List Group Memberships

To get the current memberships:

• GET /api/groups/:groupId/memberships/

Add Group Memberships

To add one or more members to a Group, use the memberships endpoint:

• POST /api/groups/:groupId/memberships/

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:

[
  {"user_id": "dcf5853e-523e-418c-bf6f-f014cd06c3c0"}, 
  {"email": "[email protected]"} 
]

Update Group Membership

To update the members of a Group, use the memberships endpoint:

• PUT /api/groups/:groupId/memberships/

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.

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:

[
  {"user_id": "dcf5853e-523e-418c-bf6f-f014cd06c3c0"}, 
  {"email": "[email protected]"} 
]

Delete Group Membership

To delete a single group membership, call the DELETE method on the membership resource.

• DELETE /api/groups/:groupId/memberships/:membershipId/

Campaign Management

Retrieve Campaign Membership

To retrieve membership information for a given campaign, use the following endpoint:

• GET /api/organizations/:organizationId/campaigns/:campaignId/members/

Update Campaign Membership

To update the name or members of a Campaign, use the campaign resource endpoint:

• GET /api/organizations/:organizationId/campaigns/: list campaigns in your organization

• PUT /api/organizations/:organizationId/campaigns/:campaignId/

The members list 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:

{
  "name": "Campaign Name",
  "users": [
    {
      "email": "[email protected]",
      "data": {
         "Location": "New York, NY"
      }
    }
  ]
}