auth
Open an operation to see its authentication, its parameters and the fields of its request and response.
12 operations
GET/v1/auth/github/callback
GitHub OAuth callback: signs in or links, then redirects to the dashboard.
/v1/auth/github/callbackAuthentication: None
Parameters
| Name | Type | Description |
|---|---|---|
codequery | string | |
statequery | string | |
errorquery | string |
Response 200
No fields.
GET/v1/auth/github/start
Starts the GitHub sign-in (or links GitHub to the signed-in user): redirects to GitHub.
/v1/auth/github/startAuthentication: None
Parameters
| Name | Type | Description |
|---|---|---|
redirect_toquery | string | |
intentquery | enum | Values signin | link |
Response 200
No fields.
POST/v1/auth/login
Opens a session with email and password.
/v1/auth/loginAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
emailrequired | string | |
passwordrequired | string |
Response 200
| 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 | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
organization.subscription_statusrequired | enum | Values none | trialing | active | past_due | canceled | incomplete | lifetime |
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 | Values direct | badge | referral | vexp | open_source | partner |
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 | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
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 |
POST/v1/auth/logout
Closes the current session; without one it still succeeds and clears the cookie.
/v1/auth/logoutAuthentication: None
Response 200
| Name | Type | Description |
|---|---|---|
okrequired | true |
POST/v1/auth/magic-link
Emails a one-time sign-in link (same answer whether or not the address exists).
/v1/auth/magic-linkAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
emailrequired | string | |
redirect_to | string |
Response 200
| Name | Type | Description |
|---|---|---|
sentrequired | true |
POST/v1/auth/magic-link/verify
Consumes a sign-in link and opens a session.
/v1/auth/magic-link/verifyAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
tokenrequired | string |
Response 200
The same fields as POST /v1/auth/login.
GET/v1/auth/me
Current user, organization, plan, accessible workspaces and session expiry.
/v1/auth/meAuthentication: Dashboard session
Response 200
The same fields as POST /v1/auth/login.
POST/v1/auth/password-reset
Emails a password reset link (same answer whether or not the address exists).
/v1/auth/password-resetAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
emailrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
sentrequired | true |
POST/v1/auth/password-reset/confirm
Sets a new password, closes every other session and opens a new one.
/v1/auth/password-reset/confirmAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
tokenrequired | string | |
passwordrequired | string |
Response 200
The same fields as POST /v1/auth/login.
POST/v1/auth/signup
Creates the organization and its owner, then opens a session.
/v1/auth/signupAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
namerequired | string | |
emailrequired | string | |
passwordrequired | string | |
organization_namerequired | string | |
organization_type | enum | Values direct | agency |
locale | enum | Values en | it |
referral_code | string | |
accept_termsrequired | true |
Response 201
| 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 | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
organization.subscription_statusrequired | enum | Values none | trialing | active | past_due | canceled | incomplete | lifetime |
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 | Values direct | badge | referral | vexp | open_source | partner |
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 | |
email_verification_requiredrequired | boolean | |
planrequired | object | |
plan.idrequired | enum | Values none | open_source | indie | startup | growth | managed | agency | enterprise |
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 |
POST/v1/auth/verify-email
Confirms the email address of the account; signs in only when nobody is signed in (409 when signed in as someone else).
/v1/auth/verify-emailAuthentication: None
Request body
| Name | Type | Description |
|---|---|---|
tokenrequired | string |
Response 200
The same fields as POST /v1/auth/login.
POST/v1/auth/verify-email/resend
Sends the verification email again.
/v1/auth/verify-email/resendAuthentication: Dashboard session
Response 200
| Name | Type | Description |
|---|---|---|
sentrequired | true |