API REFERENCE
API: authentication
Canonical routes for authentication (from ApiRoutes).
Routes
| Method | Path | Auth / notes |
|---|---|---|
| GET | /me | Bearer Cognito access token (me) |
| GET | /tenants/current | Bearer Cognito access token (tenantsCurrent) |
| GET | /tenants/current/overview | Bearer Cognito access token (tenantsCurrentOverview) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/access | Bearer Cognito access token (workspaceAccess) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/archive | Bearer Cognito access token (workspaceArchive) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/access-check | Bearer Cognito access token (workspaceAccessCheck) |
| GET | /tenants/{tenantId}/services-matrix | Bearer Cognito access token (servicesMatrixGet) |
| PATCH | /tenants/{tenantId}/services-plan/preview | Bearer Cognito access token (servicesPlanPreview) |
| POST | /tenants/{tenantId}/services-plan/submit | Bearer Cognito access token (servicesPlanSubmit) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/roles | Bearer Cognito access token (workspaceRbacRolesList) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/roles | Bearer Cognito access token (workspaceRbacRolesCreate) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/roles/{roleId} | Bearer Cognito access token (workspaceRbacRolePatch) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/role-templates | Bearer Cognito access token (workspaceRbacRoleTemplates) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/assign-role | Bearer Cognito access token (workspaceRbacAssignRole) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/revoke-role | Bearer Cognito access token (workspaceRbacRevokeRole) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/rbac/invite-member | Bearer Cognito access token (workspaceRbacInviteMember) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/check | Bearer Cognito access token (envRbacCheck) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/batch-check | Bearer Cognito access token (envRbacBatchCheck) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/roles | Bearer Cognito access token (envRbacRolesList) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/roles | Bearer Cognito access token (envRbacRolesCreate) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/roles/{roleId} | Bearer Cognito access token (envRbacRolePatch) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/permissions | Bearer Cognito access token (envRbacPermissionsList) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/members | Bearer Cognito access token (envRbacMembersList) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/invitations | Bearer Cognito access token (envRbacInvitationsList) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/assignments | Bearer Cognito access token (envRbacAssignmentsCreate) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/assignments/{assignmentId}/revoke | Bearer Cognito access token (envRbacAssignmentRevoke) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/invitations | Bearer Cognito access token (envRbacInvitationsCreate) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/invitations/{invitationId}/revoke | Bearer Cognito access token (envRbacInvitationRevoke) |
| GET | /external-rbac-invitations/{token} | Bearer Cognito access token (externalRbacInvitationGetByToken) |
| POST | /external-rbac-invitations/{token}/accept | Bearer Cognito access token (externalRbacInvitationAccept) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/api-resources | Bearer Cognito access token (envRbacApiResourcesList) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/api-resources | Bearer Cognito access token (envRbacApiResourceCreate) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/api-resources/{resourceId} | Bearer Cognito access token (envRbacApiResourcePatch) |
| DELETE | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/api-resources/{resourceId} | Bearer Cognito access token (envRbacApiResourceDelete) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/audit | Bearer Cognito access token (envRbacAuditList) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/usage | Bearer Cognito access token (envRbacUsage) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/settings | Bearer Cognito access token (envRbacSettings) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/rbac/settings | Bearer Cognito access token (envRbacSettingsPatch) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/organization-types | Bearer Cognito access token (workspaceOrganizationTypes) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/managed-organizations | Bearer Cognito access token (managedOrganizationsList) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/managed-organizations | Bearer Cognito access token (managedOrganizationsCreate) |
| GET | /tenants/{tenantId}/managed-organizations/{managedOrganizationId} | Bearer Cognito access token (managedOrganizationGet) |
| PATCH | /tenants/{tenantId}/managed-organizations/{managedOrganizationId} | Bearer Cognito access token (managedOrganizationUpdate) |
| POST | /tenants/{tenantId}/managed-organizations/{managedOrganizationId}/archive | Bearer Cognito access token (managedOrganizationArchive) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/services | Bearer Cognito access token (workspaceServicesGet) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/services | Bearer Cognito access token (workspaceServicesPatch) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/traffic-controls | Bearer Cognito access token (workspaceTrafficControlsGet) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/traffic-controls | Bearer Cognito access token (workspaceTrafficControlsPatch) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/usage | Bearer Cognito access token (workspaceUsageGet) |
| GET | /tenants/{tenantId}/environments/{environmentId}/usage | Bearer Cognito access token (environmentUsageGet) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/services/{serviceKey}/usage | Bearer Cognito access token (workspaceServiceUsageGet) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/services/chatbot/status | Bearer Cognito access token (chatbotServiceStatusGet) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/services/authentication/status | Bearer Cognito access token (authenticationServiceStatusGet) |
| POST | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/services/authentication/enable | Bearer Cognito access token (authenticationEnable) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/services/authentication/config | Bearer Cognito access token (authenticationConfigGet) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/environments/{environmentId}/services/authentication/config | Bearer Cognito access token (authenticationConfigPatch) |
| GET | /tenants/{tenantId}/authentication/pages | Bearer Cognito access token (authenticationPagesList) |
| GET | /tenants/{tenantId}/webhooks/{webhookId}/deliveries | Bearer Cognito access token (webhookDeliveriesList) |
| POST | /tenants/{tenantId}/billing/downgrade-preview | Bearer Cognito access token (billingDowngradePreview) |
| POST | /tenants/{tenantId}/billing/upgrade | Bearer Cognito access token (billingUpgrade) |
| POST | /tenants/{tenantId}/billing/downgrade | Bearer Cognito access token (billingDowngrade) |
| POST | /tenants/{tenantId}/billing/downgrade/cancel | Bearer Cognito access token (billingDowngradeCancel) |
| POST | /tenants/{tenantId}/payments/sessions | Bearer Cognito access token (paymentSessionsCreate) |
| GET | /tenants/{tenantId}/workspaces/{workspaceId}/payments | Bearer Cognito access token (workspacePaymentsList) |
| GET | /tenants/{tenantId}/members | Bearer Cognito access token (envPortalMembersList) |
| POST | /tenants/{tenantId}/members/{userId}/remove | Bearer Cognito access token (memberRemove) |
| GET | /tenants/{tenantId}/roles | Bearer Cognito access token (tenantRolesList) |
| POST | /tenants/{tenantId}/roles | Bearer Cognito access token (tenantRolesCreate) |
| PATCH | /tenants/{tenantId}/roles/{roleId} | Bearer Cognito access token (tenantRolePatch) |
| GET | /tenants/{tenantId}/roles/{roleId} | Bearer Cognito access token (tenantRoleGet) |
| DELETE | /tenants/{tenantId}/roles/{roleId} | Bearer Cognito access token (tenantRoleDelete) |
| POST | /tenants/{tenantId}/invitations/{invitationId}/revoke-access | Bearer Cognito access token (invitationRevokeAccess) |
| PATCH | /tenants/{tenantId}/invitations/{invitationId} | Bearer Cognito access token (invitationPatch) |
| POST | /tenants/{tenantId}/invitations/{invitationId}/resend | Bearer Cognito access token (invitationResend) |
| GET | /invitations/{token}/acceptance-context | Bearer Cognito access token (invitationAcceptanceContext) |
| POST | /invitations/{token}/decline | Bearer Cognito access token (invitationDecline) |
| GET | /me/invitations | Bearer Cognito access token (meInvitations) |
| POST | /me/invitations/{invitationId}/accept | Bearer Cognito access token (meInvitationAccept) |
| POST | /me/invitations/{invitationId}/decline | Bearer Cognito access token (meInvitationDecline) |
| GET | /me/tenant-memberships | Bearer Cognito access token (meTenantMemberships) |
| GET | /me/tenant-memberships | Bearer Cognito access token (mePortalSwitcher) |
| GET | /tenants/{tenantId}/members/{userId}/effective-permissions | Bearer Cognito access token (memberEffectivePermissions) |
| GET | /tenants/{tenantId}/members/{userId}/role-assignments | Bearer Cognito access token (memberRoleAssignmentsList) |
| POST | /tenants/{tenantId}/members/{userId}/role-assignments | Bearer Cognito access token (memberRoleAssignmentCreate) |
| POST | /tenants/{tenantId}/members/{userId}/role-assignments/{assignmentId}/revoke | Bearer Cognito access token (memberRoleAssignmentRevoke) |
| GET | /tenants/{tenantId}/members/{userId}/permission-overrides | Bearer Cognito access token (memberPermissionOverridesList) |
| POST | /tenants/{tenantId}/members/{userId}/permission-overrides | Bearer Cognito access token (memberPermissionOverrideCreate) |
| POST | /tenants/{tenantId}/members/{userId}/permission-overrides/{overrideId}/revoke | Bearer Cognito access token (memberPermissionOverrideRevoke) |
| GET | /tenants/{tenantId}/permission-definitions | Bearer Cognito access token (permissionDefinitionsList) |
| POST | /tenants/{tenantId}/permission-definitions | Bearer Cognito access token (permissionDefinitionCreate) |
| PATCH | /tenants/{tenantId}/permission-definitions/{permissionKey} | Bearer Cognito access token (permissionDefinitionPatch) |
| POST | /tenants/{tenantId}/permission-definitions/{permissionKey}/archive | Bearer Cognito access token (permissionDefinitionArchive) |
| GET | /tenants/{tenantId}/me/effective-permissions | Bearer Cognito access token (meEffectivePermissions) |
| GET | /tenants/{tenantId}/billing/summary | Bearer Cognito access token (billingSummary) |
| GET | /tenants/{tenantId}/billing/payment-config | Bearer Cognito access token (billingPaymentConfig) |
| GET | /tenants/{tenantId}/billing/payment-method | Bearer Cognito access token (billingPaymentMethodGet) |
| POST | /tenants/{tenantId}/billing/payment-method | Bearer Cognito access token (billingPaymentMethodSave) |
| POST | /tenants/{tenantId}/billing/payment-method/default | Bearer Cognito access token (billingPaymentMethodDefault) |
| POST | /tenants/{tenantId}/billing/payment-method/remove | Bearer Cognito access token (billingPaymentMethodRemove) |
| POST | /tenants/{tenantId}/billing/setup-intent | Bearer Cognito access token (billingSetupIntent) |
| PATCH | /tenants/{tenantId}/billing/usage-mode | Bearer Cognito access token (billingUsageMode) |
| PATCH | /tenants/{tenantId}/workspaces/{workspaceId}/usage-mode | Bearer Cognito access token (billingWorkspaceUsageMode) |
| POST | /tenants/{tenantId}/billing/downgrade-to-free | Bearer Cognito access token (billingDowngradeFree) |
| GET | /tenants/{tenantId}/spending/summary | Bearer Cognito access token (spendingSummary) |
| GET | /tenants/{tenantId}/usage/summary | Bearer Cognito access token (usageSummary) |
| GET | /tenants/{tenantId}/usage/events | Bearer Cognito access token (usageEventsList) |
| POST | /tenants/{tenantId}/usage/export | Bearer Cognito access token (usageExportCreate) |
| GET | /tenants/{tenantId}/usage/export/{exportJobId} | Bearer Cognito access token (usageExportGet) |
| POST | /tenants/{tenantId}/repair-provisioning | Bearer Cognito access token (tenantRepairProvisioning) |
| POST | /stripe/webhook/test | Bearer Cognito access token (stripeWebhookTest) |
| POST | /stripe/webhook/live | Bearer Cognito access token (stripeWebhookLive) |
| GET | /checkout/plans | Bearer Cognito access token (checkoutPlansPublic) |
| GET | /tenants/{tenantId}/billing/invoices/{invoiceId} | Bearer Cognito access token (billingInvoiceGet) |
| POST | /tenants/{tenantId}/billing/contact-sales | Bearer Cognito access token (billingContactSales) |
| GET | /checkout/pending | Bearer Cognito access token (checkoutPending) |
| POST | /checkout/pending/claim | Bearer Cognito access token (checkoutPendingClaim) |
| DELETE | /tenants/{tenantId}/chatbots/{botId}/knowledge/{itemId} | Bearer Cognito access token (knowledgeDelete) |
| POST | /tenants/{tenantId}/chatbots/{botId}/knowledge/validate | Bearer Cognito access token (knowledgeValidate) |
| DELETE | /tenants/{tenantId}/chatbots/{botId}/intents/{intentId} | Bearer Cognito access token (intentDelete) |
| GET | /tenants/{tenantId}/chatbot/overview | Bearer Cognito access token (chatbotOverview) |
| GET | /tenants/{tenantId}/chatbots/{botId}/connect | Bearer Cognito access token (chatbotConnect) |
| POST | /tenants/{tenantId}/chatbots/{botId}/test | Bearer Cognito access token (chatbotTest) |
| GET | /tenants/{tenantId}/chatbots/{botId}/publishing | Bearer Cognito access token (chatbotPublishing) |
| GET | /tenants/{tenantId}/chatbots/{botId}/conversations/{sessionId} | Bearer Cognito access token (chatbotConversationGet) |
| POST | /tenants/{tenantId}/chatbots/{botId}/archive | Bearer Cognito access token (chatbotArchive) |
| POST | /tenants/{tenantId}/chatbots/{botId}/restore | Bearer Cognito access token (chatbotRestore) |
| POST | /tenants/{tenantId}/chatbots/{botId}/duplicate | Bearer Cognito access token (chatbotDuplicate) |
| POST | /tenants/{tenantId}/chatbots/{botId}/unpublish | Bearer Cognito access token (chatbotUnpublish) |
| GET | /tenants/{tenantId}/chatbot/usage | Bearer Cognito access token (chatbotUsage) |
| GET | /tenants/{tenantId}/chatbots/{botId}/webhooks | Bearer Cognito access token (chatbotWebhooksGet) |
| PATCH | /tenants/{tenantId}/chatbots/{botId}/webhooks | Bearer Cognito access token (chatbotWebhooksUpdate) |
| GET | /widget/chatbots/{botId}/config | Public key or session token (widgetConfig) |
| POST | /widget/chatbots/{botId}/bootstrap | Public key or session token (widgetBootstrap) |
| GET | /tenants/{tenantId}/chatbots/{botId}/live-test/config | Bearer Cognito access token (chatbotLiveTestConfig) |
| POST | /tenants/{tenantId}/chatbots/{botId}/live-test/bootstrap | Bearer Cognito access token (chatbotLiveTestBootstrap) |
| GET | /admin/tenants/{tenantId}/workspaces | Platform admin JWT (adminTenantWorkspaces) |
| GET | /admin/tenants/{tenantId}/usage | Platform admin JWT (adminTenantUsage) |
| GET | /admin/tenants/{tenantId}/services | Platform admin JWT (adminTenantServices) |
| GET | /admin/tenant-contacts | Platform admin JWT (adminTenantContacts) |
| GET | /admin/tenant-contacts/{inquiryId} | Platform admin JWT (adminTenantContactGet) |
| PATCH | /admin/tenant-contacts/{inquiryId} | Platform admin JWT (adminTenantContactUpdate) |
| GET | /admin/workspaces | Platform admin JWT (adminWorkspacesList) |
| GET | /admin/environments | Platform admin JWT (adminEnvironmentsList) |
| GET | /admin/home/summary | Platform admin JWT (adminHomeSummary) |
| GET | /admin/plans | Platform admin JWT (adminPlansList) |
| GET | /admin/plans/{planKey} | Platform admin JWT (adminPlanGet) |
| POST | /admin/plans/{planKey}/versions | Platform admin JWT (adminPlanVersionCreate) |
| PATCH | /admin/plans/{planKey}/versions/{versionId} | Platform admin JWT (adminPlanVersionPatch) |
| POST | /admin/plans/{planKey}/versions/{versionId}/publish | Platform admin JWT (adminPlanVersionPublish) |
| POST | /admin/plans/{planKey}/versions/{versionId}/archive | Platform admin JWT (adminPlanVersionArchive) |
| PATCH | /admin/plans/{planKey} | Platform admin JWT (adminPlanPatch) |
| POST | /admin/plans/activate-scheduled | Platform admin JWT (adminActivateScheduledPlanVersions) |
| GET | /admin/subscriptions/overview | Platform admin JWT (adminSubscriptionsOverview) |
| GET | /admin/plan-change-announcements | Platform admin JWT (adminPlanChangeAnnouncementsList) |
| POST | /admin/plan-change-announcements | Platform admin JWT (adminPlanChangeAnnouncementCreate) |
| PATCH | /admin/plan-change-announcements/{announcementId} | Platform admin JWT (adminPlanChangeAnnouncementPatch) |
| GET | /admin/plans/{planKey}/usage-pricing | Platform admin JWT (adminPlanUsagePricingList) |
| POST | /admin/plans/{planKey}/usage-pricing | Platform admin JWT (adminPlanUsagePricingCreate) |
| PATCH | /admin/plans/{planKey}/usage-pricing/{pricingId} | Platform admin JWT (adminPlanUsagePricingPatch) |
| POST | /admin/plans/{planKey}/usage-pricing/{pricingId}/archive | Platform admin JWT (adminPlanUsagePricingArchive) |
| POST | /admin/plans/{planKey}/usage-pricing/{pricingId}/publish | Platform admin JWT (adminPlanUsagePricingPublish) |
| POST | /admin/plans/{planKey}/usage-pricing/{pricingId}/schedule | Platform admin JWT (adminPlanUsagePricingSchedule) |
| POST | /admin/plans/{planKey}/usage-pricing/{pricingId}/draft | Platform admin JWT (adminPlanUsagePricingDraft) |
| POST | /admin/usage-pricing/activate-scheduled | Platform admin JWT (adminActivateScheduledUsagePricing) |
| GET | /admin/services/{serviceKey}/usage-pricing | Platform admin JWT (adminServiceUsagePricingList) |
| GET | /admin/usage-pricing | Platform admin JWT (adminUsagePricingList) |
| GET | /tenants/{tenantId}/billing/usage-pricing | Bearer Cognito access token (tenantBillingUsagePricing) |
| GET | /tenants/{tenantId}/billing/estimated-usage-charges | Bearer Cognito access token (tenantBillingEstimatedUsageCharges) |
| GET | /tenants/{tenantId}/usage/overage-estimate | Bearer Cognito access token (tenantUsageOverageEstimate) |
| POST | /tenants/{tenantId}/payg-enrollments | Bearer Cognito access token (tenantPaygEnrollmentCreate) |
| POST | /tenants/{tenantId}/payg-enrollments/{enrollmentId}/disable | Bearer Cognito access token (tenantPaygEnrollmentDisable) |
| GET | /admin/plans/{planKey}/usage-pricing/impact | Platform admin JWT (adminPlanUsagePricingImpact) |
| GET | /admin/monitoring/summary | Platform admin JWT (adminMonitoringSummary) |
| GET | /admin/services | Platform admin JWT (adminServicesList) |
| GET | /admin/operational-services | Platform admin JWT (adminOperationalServicesList) |
| POST | /admin/services | Platform admin JWT (adminServicesCreate) |
| GET | /admin/services/{serviceKey} | Platform admin JWT (adminServiceGet) |
| PATCH | /admin/services/{serviceKey} | Platform admin JWT (adminServicePatch) |
| POST | /admin/services/{serviceKey}/activate | Platform admin JWT (adminServiceActivate) |
| POST | /admin/services/{serviceKey}/disable | Platform admin JWT (adminServiceDisable) |
| POST | /admin/services/{serviceKey}/mark-beta | Platform admin JWT (adminServiceMarkBeta) |
| POST | /admin/services/{serviceKey}/mark-coming-soon | Platform admin JWT (adminServiceMarkComingSoon) |
| POST | /admin/services/{serviceKey}/archive | Platform admin JWT (adminServiceArchive) |
| POST | /admin/services/{serviceKey}/restore | Platform admin JWT (adminServiceRestore) |
| GET | /admin/services/{serviceKey}/history | Platform admin JWT (adminServiceHistory) |
| GET | /admin/services/{serviceKey}/dependencies | Platform admin JWT (adminServiceDependenciesGet) |
| PATCH | /admin/services/{serviceKey}/dependencies | Platform admin JWT (adminServiceDependenciesPatch) |
| GET | /admin/services/{serviceKey}/versions | Platform admin JWT (adminServiceVersionsList) |
| POST | /admin/services/{serviceKey}/versions | Platform admin JWT (adminServiceVersionsCreate) |
| POST | /admin/services/{serviceKey}/versions/{versionId}/publish | Platform admin JWT (adminServiceVersionPublish) |
| POST | /admin/services/{serviceKey}/versions/{versionId}/rollback | Platform admin JWT (adminServiceVersionRollback) |
| GET | /admin/services/{serviceKey}/access | Platform admin JWT (adminServiceAccessList) |
| PATCH | /admin/services/{serviceKey}/access/global | Platform admin JWT (adminServiceAccessGlobalPatch) |
| PATCH | /admin/services/{serviceKey}/access/all-tenants | Platform admin JWT (adminServiceAccessAllTenantsPatch) |
| PATCH | /admin/services/{serviceKey}/access/tenants/{tenantId} | Platform admin JWT (adminServiceAccessTenantPatch) |
| PATCH | /admin/services/{serviceKey}/access/workspaces/{workspaceId} | Platform admin JWT (adminServiceAccessWorkspacePatch) |
| PATCH | /admin/services/{serviceKey}/access/environments/{environmentId} | Platform admin JWT (adminServiceAccessEnvironmentPatch) |
| GET | /admin/services/{serviceKey}/access/history | Platform admin JWT (adminServiceAccessHistory) |
| GET | /admin/service-access/overview | Platform admin JWT (adminServiceAccessOverview) |
| GET | /admin/services/{serviceKey}/tenants | Platform admin JWT (adminServiceTenants) |
| GET | /admin/services/{serviceKey}/usage | Platform admin JWT (adminServiceUsage) |
| GET | /admin/billing/overview | Platform admin JWT (adminBillingOverview) |
| GET | /admin/billing/invoices | Platform admin JWT (adminBillingInvoices) |
| GET | /admin/billing/payment-failures | Platform admin JWT (adminBillingPaymentFailures) |
| GET | /admin/billing/overage | Platform admin JWT (adminBillingOverage) |
| POST | /tenants/{tenantId}/alerts/{alertId}/ack | Bearer Cognito access token (tenantAlertAck) |
| GET | /tenants/{tenantId}/usage/by-action | Bearer Cognito access token (tenantUsageByAction) |
| GET | /admin/service-alerts | Platform admin JWT (adminServiceAlertsList) |
| POST | /admin/service-alerts | Platform admin JWT (adminServiceAlertsCreate) |
| PATCH | /admin/service-alerts/{alertId} | Platform admin JWT (adminServiceAlertPatch) |
| POST | /admin/service-alerts/{alertId}/publish | Platform admin JWT (adminServiceAlertPublish) |
| POST | /admin/service-alerts/{alertId}/archive | Platform admin JWT (adminServiceAlertArchive) |
| GET | /admin/support-requests | Platform admin JWT (adminSupportRequests) |
| PATCH | /admin/support-requests/{requestId} | Platform admin JWT (adminSupportRequestPatch) |
| GET | /admin/complaints | Platform admin JWT (adminComplaints) |
| PATCH | /admin/complaints/{requestId} | Platform admin JWT (adminComplaintPatch) |
| GET | /admin/feature-requests | Platform admin JWT (adminFeatureRequests) |
| PATCH | /admin/feature-requests/{requestId} | Platform admin JWT (adminFeatureRequestPatch) |
| GET | /admin/community-requests | Platform admin JWT (adminCommunityRequests) |
| GET | /admin/newsletter-subscribers | Platform admin JWT (adminNewsletterSubscribers) |
| POST | /tenants/{tenantId}/support-requests | Bearer Cognito access token (tenantSupportRequestsCreate) |
| GET | /tenants/{tenantId}/support-requests | Bearer Cognito access token (tenantSupportRequestsList) |
| POST | /tenants/{tenantId}/complaints | Bearer Cognito access token (tenantComplaintsCreate) |
| GET | /tenants/{tenantId}/complaints | Bearer Cognito access token (tenantComplaintsList) |
| POST | /tenants/{tenantId}/feature-requests | Bearer Cognito access token (tenantFeatureRequestsCreate) |
| GET | /tenants/{tenantId}/feature-requests | Bearer Cognito access token (tenantFeatureRequestsList) |
| POST | /tenants/{tenantId}/community-requests | Bearer Cognito access token (tenantCommunityRequestsCreate) |
| GET | /tenants/{tenantId}/community-requests | Bearer Cognito access token (tenantCommunityRequestsList) |
| GET | /tenants/{tenantId}/alerts | Bearer Cognito access token (tenantAlertsList) |
| POST | /newsletter/subscribe | Bearer Cognito access token (newsletterSubscribe) |
Example
GET https://api.startupcore.com/me
Errors
401 UNAUTHORIZED, 403 FORBIDDEN, 403 FEATURE_NOT_ENTITLED, 404 NOT_FOUND, 400 VALIDATION_ERROR.