Files
learnhouse-agent/skills/orgs/SKILL.md
a2a-platform 416af50961 deploy
2026-06-28 16:45:57 +00:00

25 KiB

name, description
name description
orgs-routes Handle 76 OpenAPI operation(s) under /api/v1/orgs for the orgs route group.

orgs API Routes

Handle 76 OpenAPI operation(s) under /api/v1/orgs for the orgs route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

api_create_org_api_v1_orgs_post

  • Operation ID: api_create_org_api_v1_orgs_post
  • Route: POST /api/v1/orgs/
  • Mode: WRITE
  • Summary: Create an organization
  • Body: JSON request body accepted.

api_create_org_withconfig_api_v1_orgs_withconfig_post

  • Operation ID: api_create_org_withconfig_api_v1_orgs_withconfig_post
  • Route: POST /api/v1/orgs/withconfig/
  • Mode: WRITE
  • Summary: Create an organization with config
  • Body: JSON request body accepted.

api_get_org_by_uuid_api_v1_orgs_uuid_org_uuid_get

  • Operation ID: api_get_org_by_uuid_api_v1_orgs_uuid_org_uuid_get
  • Route: GET /api/v1/orgs/uuid/{org_uuid}
  • Mode: READ
  • Summary: Get organization by UUID
  • Parameters:
    • org_uuid in path required

api_export_org_users_api_v1_orgs_org_id_users_export_get

  • Operation ID: api_export_org_users_api_v1_orgs_org_id_users_export_get
  • Route: GET /api/v1/orgs/{org_id}/users/export
  • Mode: READ
  • Summary: Export organization users as CSV
  • Parameters:
    • org_id in path required
    • search in query
    • usergroup_id in query
    • usergroup_filter in query
    • sort_order in query
    • role_id in query
    • status in query

api_get_org_users_api_v1_orgs_org_id_users_get

  • Operation ID: api_get_org_users_api_v1_orgs_org_id_users_get
  • Route: GET /api/v1/orgs/{org_id}/users
  • Mode: READ
  • Summary: List organization users
  • Parameters:
    • org_id in path required
    • page in query
    • limit in query
    • search in query
    • usergroup_id in query
    • usergroup_filter in query
    • sort_order in query
    • role_id in query
    • status in query

api_join_an_org_api_v1_orgs_join_post

  • Operation ID: api_join_an_org_api_v1_orgs_join_post
  • Route: POST /api/v1/orgs/join
  • Mode: WRITE
  • Summary: Join an organization
  • Body: JSON request body accepted.

api_update_user_role_api_v1_orgs_org_id_users_user_id_role_role_uuid_put

  • Operation ID: api_update_user_role_api_v1_orgs_org_id_users_user_id_role_role_uuid_put
  • Route: PUT /api/v1/orgs/{org_id}/users/{user_id}/role/{role_uuid}
  • Mode: WRITE
  • Summary: Update user role in organization
  • Parameters:
    • org_id in path required
    • user_id in path required
    • role_uuid in path required

api_remove_batch_users_from_org_api_v1_orgs_org_id_users_batch_remove_delete

  • Operation ID: api_remove_batch_users_from_org_api_v1_orgs_org_id_users_batch_remove_delete
  • Route: DELETE /api/v1/orgs/{org_id}/users/batch/remove
  • Mode: WRITE
  • Summary: Remove multiple users from organization
  • Parameters:
    • org_id in path required
    • user_ids in query required

api_remove_user_from_org_api_v1_orgs_org_id_users_user_id_delete

  • Operation ID: api_remove_user_from_org_api_v1_orgs_org_id_users_user_id_delete
  • Route: DELETE /api/v1/orgs/{org_id}/users/{user_id}
  • Mode: WRITE
  • Summary: Remove a user from organization
  • Parameters:
    • org_id in path required
    • user_id in path required

api_get_org_signup_mechanism_api_v1_orgs_org_id_signup_mechanism_put

  • Operation ID: api_get_org_signup_mechanism_api_v1_orgs_org_id_signup_mechanism_put
  • Route: PUT /api/v1/orgs/{org_id}/signup_mechanism
  • Mode: WRITE
  • Summary: Update organization signup mechanism
  • Parameters:
    • org_id in path required
    • signup_mechanism in query required

api_update_org_color_config_api_v1_orgs_org_id_config_color_put

  • Operation ID: api_update_org_color_config_api_v1_orgs_org_id_config_color_put
  • Route: PUT /api/v1/orgs/{org_id}/config/color
  • Mode: WRITE
  • Summary: Update organization color
  • Parameters:
    • org_id in path required
    • color in query

api_update_org_font_config_api_v1_orgs_org_id_config_font_put

  • Operation ID: api_update_org_font_config_api_v1_orgs_org_id_config_font_put
  • Route: PUT /api/v1/orgs/{org_id}/config/font
  • Mode: WRITE
  • Summary: Update organization font
  • Parameters:
    • org_id in path required
    • font in query
  • Operation ID: api_update_org_footer_text_config_api_v1_orgs_org_id_config_footer_text_put
  • Route: PUT /api/v1/orgs/{org_id}/config/footer_text
  • Mode: WRITE
  • Summary: Update organization footer text
  • Parameters:
    • org_id in path required
    • footer_text in query

api_update_org_default_language_config_api_v1_orgs_org_id_config_default_languag

  • Operation ID: api_update_org_default_language_config_api_v1_orgs_org_id_config_default_languag
  • Route: PUT /api/v1/orgs/{org_id}/config/default_language
  • Mode: WRITE
  • Summary: Update organization default language
  • Parameters:
    • org_id in path required
    • default_language in query required

api_update_org_watermark_config_api_v1_orgs_org_id_config_watermark_put

  • Operation ID: api_update_org_watermark_config_api_v1_orgs_org_id_config_watermark_put
  • Route: PUT /api/v1/orgs/{org_id}/config/watermark
  • Mode: WRITE
  • Summary: Update organization watermark
  • Parameters:
    • org_id in path required
    • watermark_enabled in query

api_update_org_auth_branding_config_api_v1_orgs_org_id_config_auth_branding_put

  • Operation ID: api_update_org_auth_branding_config_api_v1_orgs_org_id_config_auth_branding_put
  • Route: PUT /api/v1/orgs/{org_id}/config/auth_branding
  • Mode: WRITE
  • Summary: Update auth page branding
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_upload_org_auth_background_api_v1_orgs_org_id_auth_background_put

  • Operation ID: api_upload_org_auth_background_api_v1_orgs_org_id_auth_background_put
  • Route: PUT /api/v1/orgs/{org_id}/auth_background
  • Mode: WRITE
  • Summary: Upload auth page background
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_update_org_seo_config_api_v1_orgs_org_id_config_seo_put

  • Operation ID: api_update_org_seo_config_api_v1_orgs_org_id_config_seo_put
  • Route: PUT /api/v1/orgs/{org_id}/config/seo
  • Mode: WRITE
  • Summary: Update organization SEO config
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_upload_org_og_image_api_v1_orgs_org_id_og_image_put

  • Operation ID: api_upload_org_og_image_api_v1_orgs_org_id_og_image_put
  • Route: PUT /api/v1/orgs/{org_id}/og_image
  • Mode: WRITE
  • Summary: Upload OG image
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_create_invite_code_api_v1_orgs_org_id_invites_post

  • Operation ID: api_create_invite_code_api_v1_orgs_org_id_invites_post
  • Route: POST /api/v1/orgs/{org_id}/invites
  • Mode: WRITE
  • Summary: Create an invite code
  • Parameters:
    • org_id in path required
    • usergroup_id in query

api_get_invite_codes_api_v1_orgs_org_id_invites_get

  • Operation ID: api_get_invite_codes_api_v1_orgs_org_id_invites_get
  • Route: GET /api/v1/orgs/{org_id}/invites
  • Mode: READ
  • Summary: List invite codes
  • Parameters:
    • org_id in path required

api_get_invite_code_api_v1_orgs_org_id_invites_code_invite_code_get

  • Operation ID: api_get_invite_code_api_v1_orgs_org_id_invites_code_invite_code_get
  • Route: GET /api/v1/orgs/{org_id}/invites/code/{invite_code}
  • Mode: READ
  • Summary: Get an invite code
  • Parameters:
    • org_id in path required
    • invite_code in path required

api_delete_invite_code_api_v1_orgs_org_id_invites_org_invite_code_uuid_delete

  • Operation ID: api_delete_invite_code_api_v1_orgs_org_id_invites_org_invite_code_uuid_delete
  • Route: DELETE /api/v1/orgs/{org_id}/invites/{org_invite_code_uuid}
  • Mode: WRITE
  • Summary: Delete an invite code
  • Parameters:
    • org_id in path required
    • org_invite_code_uuid in path required

api_invite_batch_users_api_v1_orgs_org_id_invites_users_batch_post

  • Operation ID: api_invite_batch_users_api_v1_orgs_org_id_invites_users_batch_post
  • Route: POST /api/v1/orgs/{org_id}/invites/users/batch
  • Mode: WRITE
  • Summary: Invite a batch of users
  • Parameters:
    • org_id in path required
    • emails in query required
    • invite_code_uuid in query

api_get_org_users_invites_api_v1_orgs_org_id_invites_users_get

  • Operation ID: api_get_org_users_invites_api_v1_orgs_org_id_invites_users_get
  • Route: GET /api/v1/orgs/{org_id}/invites/users
  • Mode: READ
  • Summary: List invited users
  • Parameters:
    • org_id in path required

api_delete_org_users_invites_api_v1_orgs_org_id_invites_users_email_delete

  • Operation ID: api_delete_org_users_invites_api_v1_orgs_org_id_invites_users_email_delete
  • Route: DELETE /api/v1/orgs/{org_id}/invites/users/{email}
  • Mode: WRITE
  • Summary: Revoke an invited user
  • Parameters:
    • org_id in path required
    • email in path required

api_get_org_by_slug_api_v1_orgs_slug_org_slug_get

  • Operation ID: api_get_org_by_slug_api_v1_orgs_slug_org_slug_get
  • Route: GET /api/v1/orgs/slug/{org_slug}
  • Mode: READ
  • Summary: Get organization by slug
  • Parameters:
    • org_slug in path required

api_update_org_logo_api_v1_orgs_org_id_logo_put

  • Operation ID: api_update_org_logo_api_v1_orgs_org_id_logo_put
  • Route: PUT /api/v1/orgs/{org_id}/logo
  • Mode: WRITE
  • Summary: Update organization logo
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_update_org_favicon_api_v1_orgs_org_id_favicon_put

  • Operation ID: api_update_org_favicon_api_v1_orgs_org_id_favicon_put
  • Route: PUT /api/v1/orgs/{org_id}/favicon
  • Mode: WRITE
  • Summary: Update organization favicon
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_update_org_thumbnail_api_v1_orgs_org_id_thumbnail_put

  • Operation ID: api_update_org_thumbnail_api_v1_orgs_org_id_thumbnail_put
  • Route: PUT /api/v1/orgs/{org_id}/thumbnail
  • Mode: WRITE
  • Summary: Update organization thumbnail
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_update_org_preview_api_v1_orgs_org_id_preview_put

  • Operation ID: api_update_org_preview_api_v1_orgs_org_id_preview_put
  • Route: PUT /api/v1/orgs/{org_id}/preview
  • Mode: WRITE
  • Summary: Update organization preview image
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_user_orgs_api_v1_orgs_user_page_page_limit_limit_get

  • Operation ID: api_user_orgs_api_v1_orgs_user_page_page_limit_limit_get
  • Route: GET /api/v1/orgs/user/page/{page}/limit/{limit}
  • Mode: READ
  • Summary: List organizations for current user
  • Parameters:
    • page in path required
    • limit in path required

api_user_orgs_admin_api_v1_orgs_user_admin_page_page_limit_limit_get

  • Operation ID: api_user_orgs_admin_api_v1_orgs_user_admin_page_page_limit_limit_get
  • Route: GET /api/v1/orgs/user_admin/page/{page}/limit/{limit}
  • Mode: READ
  • Summary: List organizations the user administers
  • Parameters:
    • page in path required
    • limit in path required

api_update_org_api_v1_orgs_org_id_put

  • Operation ID: api_update_org_api_v1_orgs_org_id_put
  • Route: PUT /api/v1/orgs/{org_id}
  • Mode: WRITE
  • Summary: Update an organization
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_delete_org_api_v1_orgs_org_id_delete

  • Operation ID: api_delete_org_api_v1_orgs_org_id_delete
  • Route: DELETE /api/v1/orgs/{org_id}
  • Mode: WRITE
  • Summary: Delete an organization
  • Parameters:
    • org_id in path required

api_update_org_landing_api_v1_orgs_org_id_landing_put

  • Operation ID: api_update_org_landing_api_v1_orgs_org_id_landing_put
  • Route: PUT /api/v1/orgs/{org_id}/landing
  • Mode: WRITE
  • Summary: Update organization landing page
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_upload_org_landing_content_api_v1_orgs_org_id_landing_content_post

  • Operation ID: api_upload_org_landing_content_api_v1_orgs_org_id_landing_content_post
  • Route: POST /api/v1/orgs/{org_id}/landing/content
  • Mode: WRITE
  • Summary: Upload landing page content
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_get_org_usage_api_v1_orgs_org_id_usage_get

  • Operation ID: api_get_org_usage_api_v1_orgs_org_id_usage_get
  • Route: GET /api/v1/orgs/{org_id}/usage
  • Mode: READ
  • Summary: Get organization usage and limits
  • Parameters:
    • org_id in path required

api_update_org_ai_config_api_v1_orgs_org_id_config_ai_put

  • Operation ID: api_update_org_ai_config_api_v1_orgs_org_id_config_ai_put
  • Route: PUT /api/v1/orgs/{org_id}/config/ai
  • Mode: WRITE
  • Summary: Update organization AI config
  • Parameters:
    • org_id in path required
    • ai_enabled in query
    • copilot_enabled in query

api_update_org_communities_config_api_v1_orgs_org_id_config_communities_put

  • Operation ID: api_update_org_communities_config_api_v1_orgs_org_id_config_communities_put
  • Route: PUT /api/v1/orgs/{org_id}/config/communities
  • Mode: WRITE
  • Summary: Update organization communities config
  • Parameters:
    • org_id in path required
    • communities_enabled in query required

api_update_org_payments_config_api_v1_orgs_org_id_config_payments_put

  • Operation ID: api_update_org_payments_config_api_v1_orgs_org_id_config_payments_put
  • Route: PUT /api/v1/orgs/{org_id}/config/payments
  • Mode: WRITE
  • Summary: Update organization payments config
  • Parameters:
    • org_id in path required
    • payments_enabled in query required

api_update_org_courses_config_api_v1_orgs_org_id_config_courses_put

  • Operation ID: api_update_org_courses_config_api_v1_orgs_org_id_config_courses_put
  • Route: PUT /api/v1/orgs/{org_id}/config/courses
  • Mode: WRITE
  • Summary: Update organization courses config
  • Parameters:
    • org_id in path required
    • courses_enabled in query required

api_update_org_collections_config_api_v1_orgs_org_id_config_collections_put

  • Operation ID: api_update_org_collections_config_api_v1_orgs_org_id_config_collections_put
  • Route: PUT /api/v1/orgs/{org_id}/config/collections
  • Mode: WRITE
  • Summary: Update organization collections config
  • Parameters:
    • org_id in path required
    • collections_enabled in query required

api_update_org_podcasts_config_api_v1_orgs_org_id_config_podcasts_put

  • Operation ID: api_update_org_podcasts_config_api_v1_orgs_org_id_config_podcasts_put
  • Route: PUT /api/v1/orgs/{org_id}/config/podcasts
  • Mode: WRITE
  • Summary: Update organization podcasts config
  • Parameters:
    • org_id in path required
    • podcasts_enabled in query required

api_update_org_boards_config_api_v1_orgs_org_id_config_boards_put

  • Operation ID: api_update_org_boards_config_api_v1_orgs_org_id_config_boards_put
  • Route: PUT /api/v1/orgs/{org_id}/config/boards
  • Mode: WRITE
  • Summary: Update organization boards config
  • Parameters:
    • org_id in path required
    • boards_enabled in query required

api_update_org_playgrounds_config_api_v1_orgs_org_id_config_playgrounds_put

  • Operation ID: api_update_org_playgrounds_config_api_v1_orgs_org_id_config_playgrounds_put
  • Route: PUT /api/v1/orgs/{org_id}/config/playgrounds
  • Mode: WRITE
  • Summary: Update organization playgrounds config
  • Parameters:
    • org_id in path required
    • playgrounds_enabled in query required

get_org_ai_credits_api_v1_orgs_org_id_ai_credits_get

  • Operation ID: get_org_ai_credits_api_v1_orgs_org_id_ai_credits_get
  • Route: GET /api/v1/orgs/{org_id}/ai-credits
  • Mode: READ
  • Summary: Get AI credits summary
  • Parameters:
    • org_id in path required

add_org_ai_credits_api_v1_orgs_org_id_ai_credits_add_post

  • Operation ID: add_org_ai_credits_api_v1_orgs_org_id_ai_credits_add_post
  • Route: POST /api/v1/orgs/{org_id}/ai-credits/add
  • Mode: WRITE
  • Summary: Add purchased AI credits
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

reset_org_ai_credits_api_v1_orgs_org_id_ai_credits_reset_post

  • Operation ID: reset_org_ai_credits_api_v1_orgs_org_id_ai_credits_reset_post
  • Route: POST /api/v1/orgs/{org_id}/ai-credits/reset
  • Mode: WRITE
  • Summary: Reset AI credits usage
  • Parameters:
    • org_id in path required

set_org_ai_credits_api_v1_orgs_org_id_ai_credits_set_post

  • Operation ID: set_org_ai_credits_api_v1_orgs_org_id_ai_credits_set_post
  • Route: POST /api/v1/orgs/{org_id}/ai-credits/set
  • Mode: WRITE
  • Summary: Set purchased AI credits (superadmin only)
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_create_api_token_api_v1_orgs_org_id_api_tokens_post

  • Operation ID: api_create_api_token_api_v1_orgs_org_id_api_tokens_post
  • Route: POST /api/v1/orgs/{org_id}/api-tokens
  • Mode: WRITE
  • Summary: Create API token
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_list_api_tokens_api_v1_orgs_org_id_api_tokens_get

  • Operation ID: api_list_api_tokens_api_v1_orgs_org_id_api_tokens_get
  • Route: GET /api/v1/orgs/{org_id}/api-tokens
  • Mode: READ
  • Summary: List API tokens
  • Parameters:
    • org_id in path required

api_get_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_get

  • Operation ID: api_get_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_get
  • Route: GET /api/v1/orgs/{org_id}/api-tokens/{token_uuid}
  • Mode: READ
  • Summary: Get API token
  • Parameters:
    • org_id in path required
    • token_uuid in path required

api_update_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_put

  • Operation ID: api_update_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_put
  • Route: PUT /api/v1/orgs/{org_id}/api-tokens/{token_uuid}
  • Mode: WRITE
  • Summary: Update API token
  • Parameters:
    • org_id in path required
    • token_uuid in path required
  • Body: JSON request body accepted.

api_revoke_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_delete

  • Operation ID: api_revoke_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_delete
  • Route: DELETE /api/v1/orgs/{org_id}/api-tokens/{token_uuid}
  • Mode: WRITE
  • Summary: Revoke API token
  • Parameters:
    • org_id in path required
    • token_uuid in path required

api_regenerate_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_regenerate_pos

  • Operation ID: api_regenerate_api_token_api_v1_orgs_org_id_api_tokens_token_uuid_regenerate_pos
  • Route: POST /api/v1/orgs/{org_id}/api-tokens/{token_uuid}/regenerate
  • Mode: WRITE
  • Summary: Regenerate API token secret
  • Parameters:
    • org_id in path required
    • token_uuid in path required

api_list_webhook_events_api_v1_orgs_org_id_webhooks_events_get

  • Operation ID: api_list_webhook_events_api_v1_orgs_org_id_webhooks_events_get
  • Route: GET /api/v1/orgs/{org_id}/webhooks/events
  • Mode: READ
  • Summary: List available webhook event types
  • Parameters:
    • org_id in path required

api_create_webhook_endpoint_api_v1_orgs_org_id_webhooks_post

  • Operation ID: api_create_webhook_endpoint_api_v1_orgs_org_id_webhooks_post
  • Route: POST /api/v1/orgs/{org_id}/webhooks
  • Mode: WRITE
  • Summary: Create a webhook endpoint
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_list_webhook_endpoints_api_v1_orgs_org_id_webhooks_get

  • Operation ID: api_list_webhook_endpoints_api_v1_orgs_org_id_webhooks_get
  • Route: GET /api/v1/orgs/{org_id}/webhooks
  • Mode: READ
  • Summary: List webhook endpoints
  • Parameters:
    • org_id in path required

api_get_webhook_endpoint_api_v1_orgs_org_id_webhooks_webhook_uuid_get

  • Operation ID: api_get_webhook_endpoint_api_v1_orgs_org_id_webhooks_webhook_uuid_get
  • Route: GET /api/v1/orgs/{org_id}/webhooks/{webhook_uuid}
  • Mode: READ
  • Summary: Get a webhook endpoint
  • Parameters:
    • org_id in path required
    • webhook_uuid in path required

api_update_webhook_endpoint_api_v1_orgs_org_id_webhooks_webhook_uuid_put

  • Operation ID: api_update_webhook_endpoint_api_v1_orgs_org_id_webhooks_webhook_uuid_put
  • Route: PUT /api/v1/orgs/{org_id}/webhooks/{webhook_uuid}
  • Mode: WRITE
  • Summary: Update a webhook endpoint
  • Parameters:
    • org_id in path required
    • webhook_uuid in path required
  • Body: JSON request body accepted.

api_delete_webhook_endpoint_api_v1_orgs_org_id_webhooks_webhook_uuid_delete

  • Operation ID: api_delete_webhook_endpoint_api_v1_orgs_org_id_webhooks_webhook_uuid_delete
  • Route: DELETE /api/v1/orgs/{org_id}/webhooks/{webhook_uuid}
  • Mode: WRITE
  • Summary: Delete a webhook endpoint
  • Parameters:
    • org_id in path required
    • webhook_uuid in path required

api_regenerate_webhook_secret_api_v1_orgs_org_id_webhooks_webhook_uuid_regenerat

  • Operation ID: api_regenerate_webhook_secret_api_v1_orgs_org_id_webhooks_webhook_uuid_regenerat
  • Route: POST /api/v1/orgs/{org_id}/webhooks/{webhook_uuid}/regenerate-secret
  • Mode: WRITE
  • Summary: Regenerate a webhook signing secret
  • Parameters:
    • org_id in path required
    • webhook_uuid in path required

api_send_test_event_api_v1_orgs_org_id_webhooks_webhook_uuid_test_post

  • Operation ID: api_send_test_event_api_v1_orgs_org_id_webhooks_webhook_uuid_test_post
  • Route: POST /api/v1/orgs/{org_id}/webhooks/{webhook_uuid}/test
  • Mode: WRITE
  • Summary: Send a test webhook event
  • Parameters:
    • org_id in path required
    • webhook_uuid in path required

api_get_webhook_deliveries_api_v1_orgs_org_id_webhooks_webhook_uuid_deliveries_g

  • Operation ID: api_get_webhook_deliveries_api_v1_orgs_org_id_webhooks_webhook_uuid_deliveries_g
  • Route: GET /api/v1/orgs/{org_id}/webhooks/{webhook_uuid}/deliveries
  • Mode: READ
  • Summary: List webhook delivery logs
  • Parameters:
    • org_id in path required
    • webhook_uuid in path required
    • limit in query

api_add_custom_domain_api_v1_orgs_org_id_domains_post

  • Operation ID: api_add_custom_domain_api_v1_orgs_org_id_domains_post
  • Route: POST /api/v1/orgs/{org_id}/domains
  • Mode: WRITE
  • Summary: Add a custom domain
  • Parameters:
    • org_id in path required
  • Body: JSON request body accepted.

api_list_custom_domains_api_v1_orgs_org_id_domains_get

  • Operation ID: api_list_custom_domains_api_v1_orgs_org_id_domains_get
  • Route: GET /api/v1/orgs/{org_id}/domains
  • Mode: READ
  • Summary: List custom domains
  • Parameters:
    • org_id in path required

api_get_custom_domain_api_v1_orgs_org_id_domains_domain_uuid_get

  • Operation ID: api_get_custom_domain_api_v1_orgs_org_id_domains_domain_uuid_get
  • Route: GET /api/v1/orgs/{org_id}/domains/{domain_uuid}
  • Mode: READ
  • Summary: Get a custom domain
  • Parameters:
    • org_id in path required
    • domain_uuid in path required

api_delete_custom_domain_api_v1_orgs_org_id_domains_domain_uuid_delete

  • Operation ID: api_delete_custom_domain_api_v1_orgs_org_id_domains_domain_uuid_delete
  • Route: DELETE /api/v1/orgs/{org_id}/domains/{domain_uuid}
  • Mode: WRITE
  • Summary: Delete a custom domain
  • Parameters:
    • org_id in path required
    • domain_uuid in path required

api_get_domain_verification_info_api_v1_orgs_org_id_domains_domain_uuid_verifica

  • Operation ID: api_get_domain_verification_info_api_v1_orgs_org_id_domains_domain_uuid_verifica
  • Route: GET /api/v1/orgs/{org_id}/domains/{domain_uuid}/verification-info
  • Mode: READ
  • Summary: Get DNS verification info
  • Parameters:
    • org_id in path required
    • domain_uuid in path required

api_verify_custom_domain_api_v1_orgs_org_id_domains_domain_uuid_verify_post

  • Operation ID: api_verify_custom_domain_api_v1_orgs_org_id_domains_domain_uuid_verify_post
  • Route: POST /api/v1/orgs/{org_id}/domains/{domain_uuid}/verify
  • Mode: WRITE
  • Summary: Verify custom domain DNS
  • Parameters:
    • org_id in path required
    • domain_uuid in path required

api_check_domain_ssl_status_api_v1_orgs_org_id_domains_domain_uuid_ssl_status_ge

  • Operation ID: api_check_domain_ssl_status_api_v1_orgs_org_id_domains_domain_uuid_ssl_status_ge
  • Route: GET /api/v1/orgs/{org_id}/domains/{domain_uuid}/ssl-status
  • Mode: READ
  • Summary: Check custom domain SSL status
  • Parameters:
    • org_id in path required
    • domain_uuid in path required

api_resolve_domain_api_v1_orgs_resolve_domain_domain_get

  • Operation ID: api_resolve_domain_api_v1_orgs_resolve_domain_domain_get
  • Route: GET /api/v1/orgs/resolve/domain/{domain}
  • Mode: READ
  • Summary: Resolve custom domain to organization
  • Parameters:
    • domain in path required

api_check_domain_api_v1_orgs_domains_check_get

  • Operation ID: api_check_domain_api_v1_orgs_domains_check_get
  • Route: GET /api/v1/orgs/domains/check
  • Mode: READ
  • Summary: Check whether a custom domain is registered and verified
  • Parameters:
    • domain in query required

api_get_org_packs_api_v1_orgs_org_id_packs_get

  • Operation ID: api_get_org_packs_api_v1_orgs_org_id_packs_get
  • Route: GET /api/v1/orgs/{org_id}/packs
  • Mode: READ
  • Summary: List active and available packs
  • Parameters:
    • org_id in path required

api_get_org_pack_summary_api_v1_orgs_org_id_packs_summary_get

  • Operation ID: api_get_org_pack_summary_api_v1_orgs_org_id_packs_summary_get
  • Route: GET /api/v1/orgs/{org_id}/packs/summary
  • Mode: READ
  • Summary: Get pack totals summary
  • Parameters:
    • org_id in path required