Organizations 50 endpoints

DELETE /api/organizations/{id}
operationId: Organizations_removeById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this organization.

Responses

204

No response body
DELETE /api/organizations/{id}
GET /api/organizations/{id}
operationId: Organizations_getById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this organization.

Responses

200 —
GET /api/organizations/{id}
PATCH /api/organizations/{id}
operationId: partial_update

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this organization.

Request Body

application/json
schema PatchedOrganization
Property Type Required
id string optional
name string optional
slug string optional
teams array optional
metadata string optional
created_at string optional
updated_at string optional
customer_id string optional
enforce_2fa boolean optional
member_count string optional
membership_level integer optional
available_features array optional
plugins_access_level integer optional
available_product_features array optional
is_member_join_email_enabled boolean optional
multipart/form-data
schema PatchedOrganization
Property Type Required
id string optional
name string optional
slug string optional
teams array optional
metadata string optional
created_at string optional
updated_at string optional
customer_id string optional
enforce_2fa boolean optional
member_count string optional
membership_level integer optional
available_features array optional
plugins_access_level integer optional
available_product_features array optional
is_member_join_email_enabled boolean optional
application/x-www-form-urlencoded
schema PatchedOrganization
Property Type Required
id string optional
name string optional
slug string optional
teams array optional
metadata string optional
created_at string optional
updated_at string optional
customer_id string optional
enforce_2fa boolean optional
member_count string optional
membership_level integer optional
available_features array optional
plugins_access_level integer optional
available_product_features array optional
is_member_join_email_enabled boolean optional

Responses

200 —
PATCH /api/organizations/{id}
PUT /api/organizations/{id}
operationId: Organizations_updateById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this organization.

Request Body

required
application/json
schema Organization
Property Type Required
id string required
name string required
slug string required
teams array required
metadata string required
created_at string required
updated_at string required
customer_id string required
enforce_2fa boolean optional
member_count string required
membership_level integer required
available_features array required
plugins_access_level integer required
available_product_features array required
is_member_join_email_enabled boolean optional
multipart/form-data
schema Organization
Property Type Required
id string required
name string required
slug string required
teams array required
metadata string required
created_at string required
updated_at string required
customer_id string required
enforce_2fa boolean optional
member_count string required
membership_level integer required
available_features array required
plugins_access_level integer required
available_product_features array required
is_member_join_email_enabled boolean optional
application/x-www-form-urlencoded
schema Organization
Property Type Required
id string required
name string required
slug string required
teams array required
metadata string required
created_at string required
updated_at string required
customer_id string required
enforce_2fa boolean optional
member_count string required
membership_level integer required
available_features array required
plugins_access_level integer required
available_product_features array required
is_member_join_email_enabled boolean optional

Responses

200 —
PUT /api/organizations/{id}
GET /api/organizations/{organization_id}/batch_exports
operationId: Organizations_batchExportsList

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/batch_exports
POST /api/organizations/{organization_id}/batch_exports
operationId: Organizations_createBatchExport

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

required
application/json
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
multipart/form-data
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
application/x-www-form-urlencoded
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required

Responses

201 —
POST /api/organizations/{organization_id}/batch_exports
DELETE /api/organizations/{organization_id}/batch_exports/{id}
operationId: Organizations_deleteBatchExport

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/batch_exports/{id}
GET /api/organizations/{organization_id}/batch_exports/{id}
operationId: Organizations_getBatchExportsById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/batch_exports/{id}
PATCH /api/organizations/{organization_id}/batch_exports/{id}
operationId: Organizations_updateBatchExport

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Request Body

application/json
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array optional
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string optional
multipart/form-data
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array optional
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string optional
application/x-www-form-urlencoded
schema PatchedBatchExport
Property Type Required
id string optional
name string optional
end_at string optional
paused boolean optional
schema object optional
team_id integer optional
interval string optional
start_at string optional
created_at string optional
destination object optional
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array optional
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/batch_exports/{id}
PUT /api/organizations/{organization_id}/batch_exports/{id}
operationId: Organizations_updateBatchExport

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Request Body

required
application/json
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
multipart/form-data
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
application/x-www-form-urlencoded
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required

Responses

200 —
PUT /api/organizations/{organization_id}/batch_exports/{id}
POST /api/organizations/{organization_id}/batch_exports/{id}/backfill

Trigger a backfill for a BatchExport.

operationId: Organizations_triggerBackfill

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Request Body

required
application/json
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
multipart/form-data
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
application/x-www-form-urlencoded
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required

Responses

200 —
POST /api/organizations/{organization_id}/batch_exports/{id}/backfill
POST /api/organizations/{organization_id}/batch_exports/{id}/pause

Pause a BatchExport.

operationId: Organizations_pauseBatchExport

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Request Body

required
application/json
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
multipart/form-data
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
application/x-www-form-urlencoded
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required

Responses

200 —
POST /api/organizations/{organization_id}/batch_exports/{id}/pause
POST /api/organizations/{organization_id}/batch_exports/{id}/unpause

Unpause a BatchExport.

operationId: Organizations_unpauseBatchExport

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this batch export.
organization_id path required string —

Request Body

required
application/json
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
multipart/form-data
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required
application/x-www-form-urlencoded
schema BatchExport
Property Type Required
id string required
name string required
end_at string optional
paused boolean optional
schema object required
team_id integer required
interval string required
start_at string optional
created_at string required
destination object required
â”” type string required
â”” config object optional
hogql_query string optional
latest_runs array required
â”” id string required
â”” cursor string optional
â”” status string required
â”” created_at string required
â”” finished_at string optional
â”” batch_export string required
â”” latest_error string optional
â”” last_updated_at string required
â”” data_interval_end string required
â”” records_completed integer optional
â”” data_interval_start string required
â”” records_total_count integer optional
last_paused_at string optional
last_updated_at string required

Responses

200 —
POST /api/organizations/{organization_id}/batch_exports/{id}/unpause
GET /api/organizations/{organization_id}/domains
operationId: domains_list

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/domains
POST /api/organizations/{organization_id}/domains
operationId: domains_create

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

required
application/json
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional
multipart/form-data
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional
application/x-www-form-urlencoded
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional

Responses

201 —
POST /api/organizations/{organization_id}/domains
DELETE /api/organizations/{organization_id}/domains/{id}
operationId: domains_destroy

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this domain.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/domains/{id}
GET /api/organizations/{organization_id}/domains/{id}
operationId: domains_retrieve

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this domain.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/domains/{id}
PATCH /api/organizations/{organization_id}/domains/{id}
operationId: Organizations_updateDomainById

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this domain.
organization_id path required string —

Request Body

application/json
schema PatchedOrganizationDomain
Property Type Required
id string optional
domain string optional
has_saml boolean optional
is_verified boolean optional
verified_at string optional
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string optional
jit_provisioning_enabled boolean optional
multipart/form-data
schema PatchedOrganizationDomain
Property Type Required
id string optional
domain string optional
has_saml boolean optional
is_verified boolean optional
verified_at string optional
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string optional
jit_provisioning_enabled boolean optional
application/x-www-form-urlencoded
schema PatchedOrganizationDomain
Property Type Required
id string optional
domain string optional
has_saml boolean optional
is_verified boolean optional
verified_at string optional
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string optional
jit_provisioning_enabled boolean optional

Responses

200 —
PATCH /api/organizations/{organization_id}/domains/{id}
PUT /api/organizations/{organization_id}/domains/{id}
operationId: domains_update

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this domain.
organization_id path required string —

Request Body

required
application/json
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional
multipart/form-data
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional
application/x-www-form-urlencoded
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional

Responses

200 —
PUT /api/organizations/{organization_id}/domains/{id}
POST /api/organizations/{organization_id}/domains/{id}/verify
operationId: Organizations_verifyDomainPost

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this domain.
organization_id path required string —

Request Body

required
application/json
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional
multipart/form-data
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional
application/x-www-form-urlencoded
schema OrganizationDomain
Property Type Required
id string required
domain string required
has_saml boolean required
is_verified boolean required
verified_at string required
saml_acs_url string optional
saml_entity_id string optional
saml_x509_cert string optional
sso_enforcement string optional
verification_challenge string required
jit_provisioning_enabled boolean optional

Responses

200 —
POST /api/organizations/{organization_id}/domains/{id}/verify
GET /api/organizations/{organization_id}/invites
operationId: invites_list

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/invites
POST /api/organizations/{organization_id}/invites
operationId: invites_create

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

required
application/json
schema OrganizationInvite
Property Type Required
id string required
message string optional
created_at string required
created_by object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
first_name string optional
is_expired boolean required
updated_at string required
target_email string required
emailing_attempt_made boolean required
multipart/form-data
schema OrganizationInvite
Property Type Required
id string required
message string optional
created_at string required
created_by object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
first_name string optional
is_expired boolean required
updated_at string required
target_email string required
emailing_attempt_made boolean required
application/x-www-form-urlencoded
schema OrganizationInvite
Property Type Required
id string required
message string optional
created_at string required
created_by object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
first_name string optional
is_expired boolean required
updated_at string required
target_email string required
emailing_attempt_made boolean required

Responses

201 —
POST /api/organizations/{organization_id}/invites
POST /api/organizations/{organization_id}/invites/bulk
operationId: Organizations_bulkInviteCreate

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

required
application/json
schema OrganizationInvite
Property Type Required
id string required
message string optional
created_at string required
created_by object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
first_name string optional
is_expired boolean required
updated_at string required
target_email string required
emailing_attempt_made boolean required
multipart/form-data
schema OrganizationInvite
Property Type Required
id string required
message string optional
created_at string required
created_by object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
first_name string optional
is_expired boolean required
updated_at string required
target_email string required
emailing_attempt_made boolean required
application/x-www-form-urlencoded
schema OrganizationInvite
Property Type Required
id string required
message string optional
created_at string required
created_by object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
first_name string optional
is_expired boolean required
updated_at string required
target_email string required
emailing_attempt_made boolean required

Responses

200 —
POST /api/organizations/{organization_id}/invites/bulk
DELETE /api/organizations/{organization_id}/invites/{id}
operationId: invites_destroy

Parameters

Name In Required Type Description
id path required string

A UUID string identifying this organization invite.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/invites/{id}
GET /api/organizations/{organization_id}/members
operationId: members_list

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/members
DELETE /api/organizations/{organization_id}/members/{user__uuid}
operationId: members_destroy

Parameters

Name In Required Type Description
organization_id path required string —
user__uuid path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/members/{user__uuid}
PATCH /api/organizations/{organization_id}/members/{user__uuid}
operationId: Organizations_updateMemberByUuid

Parameters

Name In Required Type Description
organization_id path required string —
user__uuid path required string —

Request Body

application/json
schema PatchedOrganizationMember
Property Type Required
id string optional
user object optional
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
level integer optional
joined_at string optional
updated_at string optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
multipart/form-data
schema PatchedOrganizationMember
Property Type Required
id string optional
user object optional
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
level integer optional
joined_at string optional
updated_at string optional
is_2fa_enabled boolean optional
has_social_auth boolean optional
application/x-www-form-urlencoded
schema PatchedOrganizationMember
Property Type Required
id string optional
user object optional
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
level integer optional
joined_at string optional
updated_at string optional
is_2fa_enabled boolean optional
has_social_auth boolean optional

Responses

200 —
PATCH /api/organizations/{organization_id}/members/{user__uuid}
PUT /api/organizations/{organization_id}/members/{user__uuid}
operationId: members_update

Parameters

Name In Required Type Description
organization_id path required string —
user__uuid path required string —

Request Body

application/json
schema OrganizationMember
Property Type Required
id string required
user object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
level integer optional
joined_at string required
updated_at string required
is_2fa_enabled boolean required
has_social_auth boolean required
multipart/form-data
schema OrganizationMember
Property Type Required
id string required
user object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
level integer optional
joined_at string required
updated_at string required
is_2fa_enabled boolean required
has_social_auth boolean required
application/x-www-form-urlencoded
schema OrganizationMember
Property Type Required
id string required
user object required
â”” id integer required
â”” uuid string required
â”” email string required
â”” last_name string optional
â”” first_name string optional
â”” distinct_id string optional
â”” is_email_verified boolean optional
level integer optional
joined_at string required
updated_at string required
is_2fa_enabled boolean required
has_social_auth boolean required

Responses

200 —
PUT /api/organizations/{organization_id}/members/{user__uuid}
GET /api/organizations/{organization_id}/pipeline_destinations
operationId: Organizations_listPipelineDestinations

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations
POST /api/organizations/{organization_id}/pipeline_destinations
operationId: Organizations_createPipelineDestinations

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

201 —
POST /api/organizations/{organization_id}/pipeline_destinations
GET /api/organizations/{organization_id}/pipeline_destinations/activity
operationId: Organizations_getPipelineDestinationsActivity

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/activity
GET /api/organizations/{organization_id}/pipeline_destinations/exports_unsubscribe_configs
operationId: Organizations_getPipelineDestinationsExportsUnsubscribeConfigs

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/exports_unsubscribe_configs
GET /api/organizations/{organization_id}/pipeline_destinations/repository
operationId: Organizations_getPipelineDestinationRepository

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/repository
GET /api/organizations/{organization_id}/pipeline_destinations/unused
operationId: Organizations_getPipelineDestinationsUnused

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/unused
DELETE /api/organizations/{organization_id}/pipeline_destinations/{id}
operationId: Organizations_removePipelineDestination

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/pipeline_destinations/{id}
GET /api/organizations/{organization_id}/pipeline_destinations/{id}
operationId: Organizations_getPipelineDestinations

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/{id}
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}
operationId: Organizations_updatePipelineDestination

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}
PUT /api/organizations/{organization_id}/pipeline_destinations/{id}
operationId: Organizations_pipelineDestinationsUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
PUT /api/organizations/{organization_id}/pipeline_destinations/{id}
GET /api/organizations/{organization_id}/pipeline_destinations/{id}/check_for_updates
operationId: Organizations_checkForUpdates

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/{id}/check_for_updates
GET /api/organizations/{organization_id}/pipeline_destinations/{id}/source
operationId: Organizations_getPipelineDestinationsSource

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_destinations/{id}/source
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}/update_source
operationId: Organizations_updatePipelineDestinationSourcePartialUpdate

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
multipart/form-data
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional
application/x-www-form-urlencoded
schema PatchedPlugin
Property Type Required
id integer optional
tag string optional
url string optional
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string optional
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string optional
organization_name string optional

Responses

200 —
PATCH /api/organizations/{organization_id}/pipeline_destinations/{id}/update_source
POST /api/organizations/{organization_id}/pipeline_destinations/{id}/upgrade
operationId: Organizations_upgradePipelineDestination

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

200 —
POST /api/organizations/{organization_id}/pipeline_destinations/{id}/upgrade
GET /api/organizations/{organization_id}/pipeline_frontend_apps
operationId: Organizations_listPipelineFrontendApps

Parameters

Name In Required Type Description
limit query optional integer

Number of results to return per page.
offset query optional integer

The initial index from which to return the results.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps
POST /api/organizations/{organization_id}/pipeline_frontend_apps
operationId: Organizations_createPipelineFrontendApps

Parameters

Name In Required Type Description
organization_id path required string —

Request Body

application/json
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
multipart/form-data
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required
application/x-www-form-urlencoded
schema Plugin
Property Type Required
id integer required
tag string optional
url string required
icon string optional
name string optional
metrics object optional
is_global boolean optional
latest_tag string required
description string optional
plugin_type object optional
public_jobs object optional
capabilities object optional
config_schema object optional
organization_id string required
organization_name string required

Responses

201 —
POST /api/organizations/{organization_id}/pipeline_frontend_apps
GET /api/organizations/{organization_id}/pipeline_frontend_apps/activity
operationId: Organizations_getPipelineFrontendAppsActivity

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/activity
GET /api/organizations/{organization_id}/pipeline_frontend_apps/exports_unsubscribe_configs
operationId: Organizations_getPipelineFrontendAppExportsUnsubscribeConfigs

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/exports_unsubscribe_configs
GET /api/organizations/{organization_id}/pipeline_frontend_apps/repository
operationId: Organizations_getPipelineFrontendAppsRepository

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/repository
GET /api/organizations/{organization_id}/pipeline_frontend_apps/unused
operationId: Organizations_getPipelineFrontendAppsUnused

Parameters

Name In Required Type Description
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/unused
DELETE /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
operationId: Organizations_removePipelineFrontendApps

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

204

No response body
DELETE /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
operationId: Organizations_getPipelineFrontendAppsById

Parameters

Name In Required Type Description
id path required integer

A unique integer value identifying this plugin.
organization_id path required string —

Responses

200 —
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
Load more endpoints