User Management

The User Management API covers the full lifecycle of a teammate’s access: inviting them, listing who has access, managing the invitations they haven’t accepted yet, removing them, and defining custom roles with granular permissions.

Access is granted at two scopes:

• Workspace — a user belongs to a single workspace (Workspace) with an access level scoped to that workspace.
• Organization — a user belongs to the organization (Organization) and, through it, to one or more of its workspaces.

In the API, workspaces are Workspace objects and organizations are Organization objects. Access levels are the UserAccessLevel enum; custom roles are ProjectUserRole objects scoped to a single workspace.

Authentication

All requests go to the GraphQL endpoint with your personal access token in headers:

POST https://api.blue.app/graphql
blue-token-id: YOUR_TOKEN_ID
blue-token-secret: YOUR_TOKEN_SECRET
blue-org-id: YOUR_ORG_ID
blue-workspace-id: project_123   # required for workspace-scoped operations

Headers are case-insensitive. The Company and Project headers accept either an ID or a slug. See Authentication for how to create a token.

Operations

Users

Invitations

Custom roles

Access levels

UserAccessLevel has exactly six values, in descending order of capability:

Who can invite which level

The level you can assign depends on your own access level in the target workspace. VIEW_ONLY and COMMENT_ONLY users cannot invite at all.

Common patterns

Every example below is valid against the current schema. Inline IDs (project_123, user_123, …) are placeholders; substitute real IDs or slugs.

Invite a user to a workspace

inviteUser returns a plain Boolean! — there is no selection set. See Invite User for the full parameter reference.

mutation InviteToWorkspace {
  inviteUser(
    input: { email: "teammate@example.com", projectId: "project_123", accessLevel: MEMBER }
  )
}

{ "data": { "inviteUser": true } }

Invite a user to the organization

Supply companyId (requires organization OWNER) and, optionally, projectIds to add them to specific workspaces in the same call.

mutation InviteToOrganization {
  inviteUser(
    input: {
      email: "manager@example.com"
      companyId: "company_123"
      projectIds: ["project_123", "project_456"]
      accessLevel: ADMIN
    }
  )
}

List users in a workspace

workspaceUserList returns a ProjectUserList with users, a pageInfo, and a totalCount.

query WorkspaceUsers {
  workspaceUserList(projectId: "project_123", first: 25) {
    users {
      id
      fullName
      email
      image {
        medium
      }
      projectLevel(projectId: "project_123")
    }
    pageInfo {
      totalItems
      hasNextPage
    }
    totalCount
  }
}

{
  "data": {
    "workspaceUserList": {
      "users": [
        {
          "id": "clm4n8qwx000008l0g4oxdqn7",
          "fullName": "Ada Lovelace",
          "email": "ada@example.com",
          "image": { "medium": "https://blue.app/files/clm4n8qwx/medium.png" },
          "projectLevel": "MEMBER"
        }
      ],
      "pageInfo": { "totalItems": 12, "hasNextPage": false },
      "totalCount": 12
    }
  }
}

List pending invitations

Pass pending: true to return only invitations that haven’t been accepted yet.

query PendingInvitations {
  invitations(projectId: "project_123", pending: true) {
    id
    email
    accessLevel
    expiredAt
    invitedBy {
      fullName
    }
  }
}

Resend or cancel an invitation

resendInvitation refreshes the invitation’s expiry and returns the Invitation. cancelInvitation revokes it and returns a Boolean!.

mutation RefreshInvite {
  resendInvitation(id: "invitation_123") {
    id
    email
    expiredAt
  }
}

mutation RevokeInvite {
  cancelInvitation(id: "invitation_123")
}

Remove a user

Use removeProjectUser to revoke a single workspace, or removeOrganizationUser to remove the user from the whole organization. removeProjectUser returns a MutationResult (success, operationId); removeOrganizationUser returns a nullable Boolean.

mutation RemoveFromWorkspace {
  removeProjectUser(input: { projectId: "project_123", userId: "user_123" }) {
    success
    operationId
  }
}

mutation RemoveFromOrganization {
  removeOrganizationUser(input: { companyId: "company_123", userId: "user_123" })
}

You cannot remove a user whose level is OWNER; transfer ownership first. See Remove Users for the cleanup each removal performs.

Create a custom role

createWorkspaceUserRole takes flat boolean toggles (no nested permissions object) and returns a ProjectUserRole. Select only the fields the role exposes.

mutation CreateRole {
  createWorkspaceUserRole(
    input: {
      projectId: "project_123"
      name: "Content Reviewer"
      isRecordsEnabled: true
      canCreateRecords: false
      canDeleteRecords: false
    }
  ) {
    id
    name
    canCreateRecords
    canDeleteRecords
  }
}

{
  "data": {
    "createWorkspaceUserRole": {
      "id": "clm4n8qwx000008l0g4oxdqn7",
      "name": "Content Reviewer",
      "canCreateRecords": false,
      "canDeleteRecords": false
    }
  }
}

See Custom Roles for the full toggle list and per-field/per-list visibility controls.

Errors

Related

• Invite User
• List Users
• Remove Users
• Custom Roles
• Workspaces
• Record assignees