Skip to content
campaiDeveloper
campai.com

Connect · Team roles

GET/connect/organizations/{organizationId}/team-rolesReads only

List team roles

Lists all team roles for the specified organization. Returns a roles array sorted by name and then ID. Actor details may be masked depending on the caller’s permissions.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access.
  • The caller needs team.read.
  • Without user.read, non-contact actors other than the current actor are masked.
  • Without apiKey.read, API actors are masked. A non-current API actor also needs user.read to remain unmasked.
  • The legacy contact.read permission also allows contact actors to be read.

Request

Path parameters

  • organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-roles' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • rolesobject[]
    13 properties
    • _idid
    • createdAtstring · date-timenullable
    • updatedAtstring · date-timenullable
    • removedAtstring · date-timenullable
    • createdByobjectnullable
    • updatedByobjectnullable
    • removedByobjectnullable
    • __ignoreTriggersstringnullable
    • organizationid
    • namestring

      1–32 characters

    • descriptionstring

      at most 256 characters

    • permissionsobject
      5 properties
      • contactobject
        10 properties
        • readobject of boolean
          Keys: one of 7 values
          member address customer sponsor contributor employee supplier
        • communicationboolean
        • personalboolean
        • departmentsboolean
        • groupsboolean
        • billingboolean
        • contractsboolean
        • notesboolean
        • proofsCertificatesboolean
        • tagsboolean
      • userobject of boolean
        Keys: one of 3 values
        list read chat
      • chatobject
        22 properties
        • createActivityboolean
        • createPollboolean
        • createAvailabilityboolean
        • createSignupboolean
        • createChecklistboolean
        • createFormboolean
        • createChallengeboolean
        • participatePollboolean
        • participateAvailabilityboolean
        • participateSignupboolean
        • participateChecklistboolean
        • participateFormboolean
        • participateChallengeboolean
        • manageActivitiesboolean
        • replyboolean
        • reactboolean
        • mentionboolean
        • mentionEveryoneboolean
        • manageboolean
        • changeAppearanceboolean
        • pinboolean
        • viewContactNameboolean
      • todoobject of boolean
        Keys: one of 2 values
        read manage
      • fileobject of boolean
        Keys: one of 4 values
        view manageFolders manageOwnFiles manageAllFiles
    • referenceRevisioninteger

      at least 0

Response200
{
  "roles": [
    {
      "_id": "000000000000000000000001",
      "organization": "000000000000000000000001",
      "name": "string",
      "description": "string",
      "permissions": {
        "contact": {
          "read": {
            "key": true
          },
          "communication": true,
          "personal": true
        },
        "user": {
          "key": true
        },
        "chat": {
          "createActivity": true,
          "createPoll": true,
          "createAvailability": true
        }
      }
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.