Organizations-2
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
PATCH | |
DELETE | |
GET | |
POST | |
POST | |
GET | |
GET | |
DELETE | |
PATCH | |
GET | |
POST | |
DELETE | |
POST | |
POST | |
GET | |
POST | |
GET | |
GET | |
GET |
Update domains
Required API key scopes
organization:writePath parameters
- idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
Response
Example request
PATCH /api /organizations /:organization_id /domains /:idExample response
Status 200
Delete domains
Required API key scopes
organization:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /domains /:idExample response
Status 204 No response body
Retrieve domains scim logs
Path parameters
- idstring
Example request
GET /api /organizations /:organization_id /domains /:id /scim /logsExample response
Status 200 No response body
Create domains scim token
Regenerate SCIM bearer token.
Path parameters
- idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
Example request
POST /api /organizations /:organization_id /domains /:id /scim /tokenExample response
Status 200 No response body
Create domains verify
Path parameters
- idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstringnull
- saml_acs_urlstringnull
- saml_x509_certstringnull
- scim_enabledboolean
Example request
POST /api /organizations /:organization_id /domains /:id /verifyExample response
Status 200 No response body
List all org organizations integrations
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Required API key scopes
organization_integration:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /integrationsExample response
Status 200
Retrieve org organizations integrations
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Required API key scopes
organization_integration:readPath parameters
- idstring
Response
Example request
GET /api /organizations /:organization_id /integrations /:idExample response
Status 200
Delete org organization integrations
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Required API key scopes
organization_integration:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /integrations /:idExample response
Status 204 No response body
Update integrations environment mapping
ViewSet for organization-level integrations.
Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
Path parameters
- idstring
Request parameters
Response
Example request
PATCH /api /organizations /:organization_id /integrations /:id /environment-mappingExample response
Status 200
List all invites
Required API key scopes
organization_member:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /invitesExample response
Status 200
Create invites
Required API key scopes
organization_member:writeRequest parameters
- target_emailstring
- first_namestring
- level
- messagestringnull
- private_project_access
- send_emailbooleanDefault:
true - combine_pending_invitesbooleanDefault:
false
Response
Example request
POST /api /organizations /:organization_id /invitesExample response
Status 201
Delete invites
Required API key scopes
organization_member:writePath parameters
- idstring
Example request
DELETE /api /organizations /:organization_id /invites /:idExample response
Status 204 No response body
Create invites bulk
Required API key scopes
organization_member:writeRequest parameters
- target_emailstring
- first_namestring
- level
- messagestringnull
- private_project_access
- send_emailbooleanDefault:
true - combine_pending_invitesbooleanDefault:
false
Example request
POST /api /organizations /:organization_id /invites /bulkExample response
Status 200 No response body
Create invites delegate
Create an onboarding delegation invite: an admin-level invite flagged as a setup delegation. Sends a single dedicated delegation email and records the inviting user as having delegated.
Required API key scopes
organization_member:writeRequest parameters
- target_emailstring
- messagestring
- step_at_delegationstring
Response
Example request
POST /api /organizations /:organization_id /invites /delegateExample response
Status 200
List all legal documents
Required API key scopes
legal_document:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /legal_documentsExample response
Status 200
Create legal documents
Required API key scopes
legal_document:writeRequest parameters
- document_type
- company_namestring
- company_addressstring
- representative_emailstring
Response
Example request
POST /api /organizations /:organization_id /legal_documentsExample response
Status 201
Retrieve legal documents
Required API key scopes
legal_document:readPath parameters
- idstring
Response
Example request
GET /api /organizations /:organization_id /legal_documents /:idExample response
Status 200
Retrieve legal documents download
Short-lived redirect to the signed PDF in object storage. 404 while the envelope is still out for signature (or if the upload hasn't completed yet). The underlying presigned URL expires in ~60s; clients should hit this endpoint each time they want to view the PDF rather than caching.
Path parameters
- idstring
Example request
GET /api /organizations /:organization_id /legal_documents /:id /downloadExample response
Status 302 No response body
Status 404 No response body
List all members
Required API key scopes
organization_member:readQuery parameters
- limitinteger
- offsetinteger
- orderstringOne of:
"-joined_at""joined_at" - searchstring
Response
Example request
GET /api /organizations /:organization_id /members