Skip to main content
POST
Invite user to project

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

Body

application/json
email
string<email>
required

Email address of the user to invite

permissions
enum<string>[]
required

Permissions to grant to the user

  • CAN_PERFORM_ADMIN_ACTIONS: Full administrative access
  • CAN_VIEW_DATA: Read-only access to project data
  • CAN_IMPERSONATE_OTHER_USERS: Impersonate other users in API calls (contact Clarifeye to enable)
Available options:
CAN_PERFORM_ADMIN_ACTIONS,
CAN_VIEW_DATA,
CAN_IMPERSONATE_OTHER_USERS
Example:
profile
enum<string>
default:contributor

Profile to assign to the invited user on the project. Defaults to contributor when omitted.

Available options:
tech,
contributor,
user

Response

Invitation created successfully

id
string<uuid>
email
string<email>
permissions
enum<string>[]
  • CAN_PERFORM_ADMIN_ACTIONS: Full administrative access
  • CAN_VIEW_DATA: Read-only access to project data
  • CAN_IMPERSONATE_OTHER_USERS: Impersonate other users in API calls (contact Clarifeye to enable)
Available options:
CAN_PERFORM_ADMIN_ACTIONS,
CAN_VIEW_DATA,
CAN_IMPERSONATE_OTHER_USERS
profile
enum<string>
default:contributor

Profile of the user on the project. The profile shapes the UI surface a user sees (sidebar, available views) and complements the fine-grained permissions list.

  • tech: Technical profile with access to advanced/technical interfaces
  • contributor: Default profile for users who contribute to the project
  • user: End-user profile with the most restricted UI surface
Available options:
tech,
contributor,
user
status
enum<string>
  • pending: Invitation sent, awaiting response
  • accepted: User accepted the invitation
  • cancelled: Invitation was cancelled
Available options:
pending,
accepted,
cancelled
created_at
string<date-time>
updated_at
string<date-time>
invited_by
object
type
enum<string>
  • new_user: User not registered, invite is pending
  • existing_user: User exists, invite auto-accepted
Available options:
new_user,
existing_user