`invitations`

Open an operation to see its authentication, its parameters and the fields of its request and response.

5 operations

GET`/v1/invitations`

Invitations of the organization, newest first (owner, admin).

Authentication: Dashboard session

Parameters

Parameters, GET /v1/invitations
Name	Type	Description
`status`query	`enum`	Values `pending \| accepted \| revoked \| expired`

Response `200`

Response, GET /v1/invitations
Name	Type	Description
`items`required	`array of object`
`items[].id`required	`string`
`items[].org_id`required	`string`
`items[].email`required	`string (email)`
`items[].role`required	`enum`	Values `owner \| admin \| reviewer \| client_viewer`
`items[].workspace_ids`required	`array of string`
`items[].invited_by_user_id`required	`string`
`items[].status`required	`enum`	Values `pending \| accepted \| revoked \| expired`
`items[].expires_at`required	`string (date-time)`
`items[].accepted_at`required	`string (date-time)`
`items[].revoked_at`required	`string (date-time)`
`items[].created_at`required	`string (date-time)`

POST`/v1/invitations`

Invites a person by email (owner, admin); the link is valid 7 days.

Authentication: Dashboard session

Request body

Request body, POST /v1/invitations
Name	Type	Description
`email`required	`string`
`role`required	`enum`	Values `owner \| admin \| reviewer \| client_viewer`
`workspace_ids`	`array of string`

Response `201`

Response, POST /v1/invitations
Name	Type	Description
`id`required	`string`
`org_id`required	`string`
`email`required	`string (email)`
`role`required	`enum`	Values `owner \| admin \| reviewer \| client_viewer`
`workspace_ids`required	`array of string`
`invited_by_user_id`required	`string`
`status`required	`enum`	Values `pending \| accepted \| revoked \| expired`
`expires_at`required	`string (date-time)`
`accepted_at`required	`string (date-time)`
`revoked_at`required	`string (date-time)`
`created_at`required	`string (date-time)`

DELETE`/v1/invitations/{id}`

Revokes a pending invitation (owner, admin).

Authentication: Dashboard session

Parameters

Parameters, DELETE /v1/invitations/{id}
Name	Type	Description
`id`pathrequired	`string`

Response `200`

The same fields as POST /v1/invitations.

POST`/v1/invitations/accept`

Joins the organization (creating the account if needed) and opens a session.

Authentication: None

Request body

Request body, POST /v1/invitations/accept
Name	Type	Description
`token`required	`string`
`name`	`string`
`password`	`string`

Response `200`

Response, POST /v1/invitations/accept
Name	Type	Description
`user`required	`object`
`user.id`required	`string`
`user.org_id`required	`string`
`user.email`required	`string (email)`
`user.name`required	`string`
`user.role`required	`enum`	Values `owner \| admin \| reviewer \| client_viewer`
`user.workspace_ids`required	`array of string`
`user.email_verified_at`required	`string (date-time)`
`user.github_login`required	`string`
`user.locale`required	`enum`	Values `en \| it`
`user.last_login_at`required	`string (date-time)`
`user.disabled_at`required	`string (date-time)`
`user.created_at`required	`string (date-time)`
`user.updated_at`required	`string (date-time)`
`organization`required	`object`
`organization.id`required	`string`
`organization.name`required	`string`
`organization.slug`required	`string`
`organization.type`required	`enum`	Values `direct \| agency`
`organization.plan`required	`enum`	Values `none \| open_source \| indie \| startup \| growth \| managed \| agency \| enterprise`
`organization.subscription_status`required	`enum`	Values `none \| trialing \| active \| past_due \| canceled \| incomplete \| lifetime`
`organization.trial_ends_at`required	`string (date-time)`
`organization.current_period_end`required	`string (date-time)`
`organization.plan_activated_at`required	`string (date-time)`
`organization.billing_email`required	`string (email)`
`organization.spend_cap_usd`required	`number`
`organization.show_engine_brand`required	`boolean`
`organization.patterns_opt_in`required	`boolean`
`organization.badge_removal_addon`required	`boolean`
`organization.overage_enabled`required	`boolean`
`organization.retention_days`required	`integer`
`organization.signup_source`required	`enum`	Values `direct \| badge \| referral \| vexp \| open_source \| partner`
`organization.referral_code`required	`string`
`organization.locale`required	`enum`	Values `en \| it`
`organization.sso_enforced`required	`boolean`
`organization.approval_min_approvers`required	`integer`
`organization.approval_roles`required	`array of enum`
`organization.stripe_connect_account_id`required	`string`
`organization.connect_charges_enabled`required	`boolean`
`organization.demo_used_at`required	`string (date-time)`
`organization.created_at`required	`string (date-time)`
`organization.updated_at`required	`string (date-time)`
`workspaces`required	`array of object`
`workspaces[].id`required	`string`
`workspaces[].name`required	`string`
`workspaces[].slug`required	`string`
`workspaces[].client_name`required	`string`
`workspaces[].execution_mode`required	`enum`	Values `managed \| runner \| mcp`
`workspaces[].autonomy`required	`enum`	Values `copilot \| approve \| autopilot`
`workspaces[].archived_at`required	`string (date-time)`
`session`required	`object`
`session.expires_at`required	`string (date-time)`
`session.sso`required	`boolean`
`staff`required	`boolean`
`plan`required	`object`
`plan.id`required	`enum`	Values `none \| open_source \| indie \| startup \| growth \| managed \| agency \| enterprise`
`plan.name`required	`string`
`plan.features`required	`array of enum`
`plan.autonomy`required	`array of enum`
`plan.execution_modes`required	`array of enum`
`plan.limits`required	`object`
`plan.limits.tickets_per_month`required	`integer`
`plan.limits.repositories_per_workspace`required	`integer`
`plan.limits.public_repos_only`required	`boolean`
`plan.limits.workspaces_included`required	`integer`
`plan.limits.extra_workspace_price_usd`required	`number`
`plan.limits.included_fixes_per_month`required	`integer`
`plan.limits.overage_fix_price_usd`required	`number`

POST`/v1/invitations/preview`

Shows who invited whom, before accepting (the emailed token is the credential).

Authentication: None

Request body

Request body, POST /v1/invitations/preview
Name	Type	Description
`token`required	`string`

Response `200`

Response, POST /v1/invitations/preview
Name	Type	Description
`email`required	`string`
`organization_name`required	`string`
`role`required	`enum`	Values `owner \| admin \| reviewer \| client_viewer`
`invited_by_name`required	`string`
`workspace_names`required	`array of string`
`expires_at`required	`string (date-time)`
`existing_user`required	`boolean`

Name

Type

Description

statusquery

enum

Values pending | accepted | revoked | expired

Name

Type

Description

itemsrequired

array of object

items[].idrequired

string

items[].org_idrequired

string

items[].emailrequired

string (email)

items[].rolerequired

enum

Values owner | admin | reviewer | client_viewer

items[].workspace_idsrequired

array of string

items[].invited_by_user_idrequired

string

items[].statusrequired

enum

Values pending | accepted | revoked | expired

items[].expires_atrequired

string (date-time)

items[].accepted_atrequired

string (date-time)

items[].revoked_atrequired

string (date-time)

items[].created_atrequired

string (date-time)

Name

Type

Description

emailrequired

string

rolerequired

enum

Values owner | admin | reviewer | client_viewer

workspace_ids

array of string

Name

Type

Description

idrequired

string

org_idrequired

string

emailrequired

string (email)

rolerequired

enum

Values owner | admin | reviewer | client_viewer

workspace_idsrequired

array of string

invited_by_user_idrequired

string

statusrequired

enum

Values pending | accepted | revoked | expired

expires_atrequired

string (date-time)

accepted_atrequired

string (date-time)

revoked_atrequired

string (date-time)

created_atrequired

string (date-time)

Name

Type

Description

idpathrequired

string

Name

Type

Description

tokenrequired

string

name

string

password

string

Name

Type

Description

userrequired

object

user.idrequired

string

user.org_idrequired

string

user.emailrequired

string (email)

user.namerequired

string

user.rolerequired

enum

Values owner | admin | reviewer | client_viewer

user.workspace_idsrequired

array of string

user.email_verified_atrequired

string (date-time)

user.github_loginrequired

string

user.localerequired

enum

Values en | it

user.last_login_atrequired

string (date-time)

user.disabled_atrequired

string (date-time)

user.created_atrequired

string (date-time)

user.updated_atrequired

string (date-time)

organizationrequired

object

organization.idrequired

string

organization.namerequired

string

organization.slugrequired

string

organization.typerequired

enum

Values direct | agency

organization.planrequired

enum

organization.subscription_statusrequired

enum

organization.trial_ends_atrequired

string (date-time)

organization.current_period_endrequired

string (date-time)

organization.plan_activated_atrequired

string (date-time)

organization.billing_emailrequired

string (email)

organization.spend_cap_usdrequired

number

organization.show_engine_brandrequired

boolean

organization.patterns_opt_inrequired

boolean

organization.badge_removal_addonrequired

boolean

organization.overage_enabledrequired

boolean

organization.retention_daysrequired

integer

organization.signup_sourcerequired

enum

organization.referral_coderequired

string

organization.localerequired

enum

Values en | it

organization.sso_enforcedrequired

boolean

organization.approval_min_approversrequired

integer

organization.approval_rolesrequired

array of enum

organization.stripe_connect_account_idrequired

string

organization.connect_charges_enabledrequired

boolean

organization.demo_used_atrequired

string (date-time)

organization.created_atrequired

string (date-time)

organization.updated_atrequired

string (date-time)

workspacesrequired

array of object

workspaces[].idrequired

string

workspaces[].namerequired

string

workspaces[].slugrequired

string

workspaces[].client_namerequired

string

workspaces[].execution_moderequired

enum

Values managed | runner | mcp

workspaces[].autonomyrequired

enum

Values copilot | approve | autopilot

workspaces[].archived_atrequired

string (date-time)

sessionrequired

object

session.expires_atrequired

string (date-time)

session.ssorequired

boolean

staffrequired

boolean

planrequired

object

plan.idrequired

enum

plan.namerequired

string

plan.featuresrequired

array of enum

plan.autonomyrequired

array of enum

plan.execution_modesrequired

array of enum

plan.limitsrequired

object

plan.limits.tickets_per_monthrequired

integer

plan.limits.repositories_per_workspacerequired

integer

plan.limits.public_repos_onlyrequired

boolean

plan.limits.workspaces_includedrequired

integer

plan.limits.extra_workspace_price_usdrequired

number

plan.limits.included_fixes_per_monthrequired

integer

plan.limits.overage_fix_price_usdrequired

number

Name

Type

Description

tokenrequired

string

Name

Type

Description

emailrequired

string

organization_namerequired

string

rolerequired

enum

Values owner | admin | reviewer | client_viewer

invited_by_namerequired

string

workspace_namesrequired

array of string

expires_atrequired

string (date-time)

existing_userrequired

boolean

GET/v1/invitations

Parameters

Response 200

POST/v1/invitations

Request body

Response 201

DELETE/v1/invitations/{id}

Parameters

Response 200

POST/v1/invitations/accept

Request body

Response 200

POST/v1/invitations/preview

Request body

Response 200

GET/v1/invitations

Parameters

Response 200

POST/v1/invitations

Request body

Response 201

DELETE/v1/invitations/{id}

Parameters

Response 200

POST/v1/invitations/accept

Request body

Response 200

POST/v1/invitations/preview

Request body

Response 200

GET`/v1/invitations`

Response `200`

POST`/v1/invitations`

Response `201`

DELETE`/v1/invitations/{id}`

Response `200`

POST`/v1/invitations/accept`

Response `200`

POST`/v1/invitations/preview`

Response `200`

GET`/v1/invitations`

Response `200`

POST`/v1/invitations`

Response `201`

DELETE`/v1/invitations/{id}`

Response `200`

POST`/v1/invitations/accept`

Response `200`

POST`/v1/invitations/preview`

Response `200`