{"openapi":"3.0.3","info":{"title":"Palform","version":""},"servers":[],"paths":{"/api/health":{"get":{"tags":["Health"],"operationId":"health.ping","responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}}},"deprecated":false,"security":[]}},"/api/auth/social/providers":{"get":{"tags":["Authentication"],"operationId":"auth.social.list","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSocialAuthProvidersResponse"}}}}},"deprecated":false,"security":[]}},"/api/auth/social/start":{"post":{"tags":["Authentication"],"operationId":"auth.social.start","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartSocialAuthRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartSocialAuthResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/social/callback":{"post":{"tags":["Authentication"],"operationId":"auth.social.callback","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialAuthCallbackRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialAuthCallbackResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/password_reset/send":{"post":{"tags":["Password Resets"],"operationId":"user.password_reset.send","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendPasswordResetRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/password_reset/reset":{"put":{"tags":["Password Resets"],"operationId":"user.password_reset.reset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/tfa":{"get":{"tags":["2FA Methods"],"operationId":"user.second_factors.list","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIAdminUserSecondAuthenticationFactor"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/tfa/{factor_id}":{"delete":{"tags":["2FA Methods"],"operationId":"user.second_factors.delete","parameters":[{"name":"factor_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user_2fa"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/tfa/enroll/totp":{"post":{"tags":["2FA Methods"],"operationId":"user.second_factors.enroll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollTOTPRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/tfa/enroll/webauthn":{"post":{"tags":["2FA Methods"],"operationId":"user.second_factors.enroll_webauthn","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollWebauthnRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/tfa/start/webauthn":{"post":{"tags":["2FA Methods"],"operationId":"user.second_factors.start_webauthn","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartWebauthnResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/signup":{"post":{"tags":["Authentication"],"operationId":"auth.sign_up","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"verified_captcha":[]}]}},"/api/auth/signin/signin":{"post":{"tags":["Authentication"],"operationId":"auth.sign_in","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignInRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignInResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"verified_captcha":[]}]}},"/api/auth/signin/verify_tfa":{"post":{"tags":["Authentication"],"operationId":"auth.verify_tfa","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyTFARequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignInResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/tokens/current":{"delete":{"tags":["Authentication"],"operationId":"auth.invalidate_token","responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/test":{"get":{"tags":["Authentication"],"summary":"Test authentication","description":"\\\nChecks whether the provided Authorization header is valid and returns the user's ID","operationId":"auth.test","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthTestResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/auth/verification/resend":{"post":{"tags":["Authentication"],"operationId":"auth.resend_ verification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendVerificationRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/verification/{verification_id}":{"post":{"tags":["Authentication"],"operationId":"auth.verify","parameters":[{"name":"verification_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user_email_verification"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/{org_id}/callback":{"post":{"tags":["Authentication"],"summary":"Process authentication callback","description":"\\\nHandle the callback from the OIDC server and generate an API key to be used for future requests","operationId":"auth.callback","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthCallbackRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthCallbackResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/auth/{org_id}/start":{"post":{"tags":["Authentication"],"summary":"Start authentication flow","description":"\\\nGenerate an OIDC URL with the configured provider to start authentication","operationId":"auth.start","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"redirect_url","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartAuthResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/users/me":{"patch":{"tags":["Admin Users"],"operationId":"admin_users.update","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdminUserRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/feedback":{"post":{"tags":["Feedback"],"operationId":"feedback.create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFeedbackItem"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/fonts":{"get":{"tags":["Form Brandings"],"operationId":"google_fonts","responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/countries/calling_codes":{"get":{"tags":["Country Metadata"],"operationId":"countries.list_calling_codes","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APICountryWithCallingCode"}}}}}},"deprecated":false,"security":[]}},"/api/countries/names":{"get":{"tags":["Country Metadata"],"operationId":"countries.list_names","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APICountryWithISOCode"}}}}}},"deprecated":false,"security":[]}},"/api/templates/top":{"get":{"tags":["Form Templates"],"operationId":"form_templates.list_top","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIFormTemplate"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/templates/categories":{"get":{"tags":["Form Templates"],"operationId":"form_templates.categories.list","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIFormTemplateCategory"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/templates/categories/{category_id}":{"get":{"tags":["Form Templates"],"operationId":"form_templates.categories.get","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_tmplcat"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFormTemplateCategory"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/templates/categories/{category_id}/all":{"get":{"tags":["Form Templates"],"operationId":"form_templates.list","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_tmplcat"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIFormTemplate"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/templates/{template_id}":{"get":{"tags":["Form Templates"],"operationId":"form_templates.get","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFormTemplate"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/templates/{template_id}/views":{"post":{"tags":["Form Templates"],"operationId":"form_templates.report_view","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/billing/plans":{"get":{"tags":["Billing Plans"],"operationId":"billing.plan.list","parameters":[{"name":"currency","in":"query","required":false,"schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIBillingCurrencyResponse_for_Array_of_APIBillingPlan"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/billing/webhook":{"post":{"tags":["Billing Webhooks"],"operationId":"billing.webhook.receive","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StripeSignature"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/captcha":{"get":{"tags":["Captcha"],"operationId":"captcha.create","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Map_of_AnyValue"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/org/orgs/for-subdomain":{"get":{"tags":["Organisations"],"summary":"Return an organisation's metadata by its subdomain.","operationId":"orgs.resolve_subdomain","parameters":[{"name":"subdomain","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/org/orgs":{"get":{"tags":["Organisations"],"summary":"List organisations","description":"\\\nList all the organisations that the authenticated user is a member of.","operationId":"orgs.list","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisation"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Organisations"],"operationId":"orgs.create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewOrganisationRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/orgs/{org_id}":{"get":{"tags":["Organisations"],"summary":"Get metadata about an organisation.","operationId":"orgs.get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisation"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"patch":{"tags":["Organisations"],"summary":"Update the metadata of an organisation.","operationId":"orgs.rename","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOrgRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Organisations"],"operationId":"orgs.delete","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationsDeleteRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationManifest"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/orgs/{org_id}/subdomain":{"post":{"tags":["Organisations"],"summary":"Configure a subdomain for an organisation.","description":"\\\nThis operation is currently irreversible. Once configured, the organisation's subdomain cannot\\\nbe changed or removed.","operationId":"orgs.create_subdomain","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubdomainRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/auth_config":{"get":{"tags":["Organisation Authentication Configuration"],"operationId":"organisation.auth_config.get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationAuthConfig"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"put":{"tags":["Organisation Authentication Configuration"],"operationId":"organisation.auth_config.put","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationAuthConfig"}}},"required":false},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/mappings":{"get":{"tags":["Organisation Authentication Team Mappings"],"operationId":"organisation.auth_config.mappings.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisationAuthTeamMapping"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Organisation Authentication Team Mappings"],"operationId":"organisation.auth_config.mappings.create","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationAuthTeamMappingRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/mappings/{mapping_id}":{"delete":{"tags":["Organisation Authentication Team Mappings"],"operationId":"organisation.auth_config.mappings.delete","parameters":[{"name":"mapping_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org_auth_team_map"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/invites":{"get":{"tags":["Organisation Invites"],"operationId":"organisation.invites.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisationInvite"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Organisation Invites"],"operationId":"organisation.invites.create","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewOrganisationInviteRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationInvite"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/invites/{invite_id}/preview":{"get":{"tags":["Organisation Invites"],"operationId":"organisation.invites.preview","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org_invite"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationInvitePreview"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/{org_id}/invites/{invite_id}":{"delete":{"tags":["Organisation Invites"],"operationId":"organisation.invites.delete","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org_invite"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/members/am-i-admin":{"get":{"tags":["Organisation Members"],"operationId":"organisation.members.am_i_admin","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"Boolean","type":"boolean"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/members":{"get":{"tags":["Organisation Members"],"operationId":"organisation.members.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrgMemberHuman"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Organisation Members"],"operationId":"organisation.members.join","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinOrganisationRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/{org_id}/members/service-accounts":{"get":{"tags":["Organisation Members"],"operationId":"organisation.members.list_service_account","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrgMemberServiceAccount"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/members/{user_id}":{"patch":{"tags":["Organisation Members"],"operationId":"organisation.members.patch","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"user_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchOrgMemberRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Organisation Members"],"operationId":"organisation.members.delete","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"user_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/deletion_requests":{"get":{"tags":["Organisation Deletion Requests"],"operationId":"organisation_deletion_requests.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisationDeletionRequest"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/{org_id}/deletion_requests/{request_id}":{"delete":{"tags":["Organisation Deletion Requests"],"operationId":"organisation_deletion_requests.cancel","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"request_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org_delete"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/{org_id}/deletion_requests/{request_id}/skip":{"post":{"tags":["Organisation Deletion Requests"],"operationId":"organisation_deletion_requests.skip","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"request_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org_delete"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"personal_token":[]}]}},"/api/org/{org_id}/induction":{"get":{"tags":["Induction"],"operationId":"induction.status","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InductionStatus"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/induction/alert":{"get":{"tags":["Induction"],"operationId":"induction.alert","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/audit":{"get":{"tags":["Audit Logs"],"summary":"List all audit logs for an organisation.","operationId":"audit.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"from","in":"query","required":false,"schema":{"default":null,"type":"string","format":"date-time","nullable":true}},{"name":"resource","in":"query","required":false,"schema":{"default":null,"allOf":[{"$ref":"#/components/schemas/AuditLogTargetResourceEnum"}],"nullable":true}},{"name":"to","in":"query","required":false,"schema":{"default":null,"type":"string","format":"date-time","nullable":true}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIAuditLogEntry"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/keys/my":{"get":{"tags":["User keys"],"summary":"List user keys","description":"\\\nLists the public keys associated with the currently user's account within the\\\nspecified organisation, in PEM-encoded format. Expired keys will also be included in the list.","operationId":"keys.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIUserKey"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["User keys"],"summary":"Register new public key","description":"\\\nRegisters a new public key to the authenticated user's account. New responses to forms that are\\\nin teams that the user is a member of will start being encrypted with the new key immediately.","operationId":"keys.register","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterKeyRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/keys/all":{"get":{"tags":["Organisation Keys"],"summary":"List all keys for all users within an organisation.","description":"\\\nExpired keys will be included in the list.","operationId":"org.keys.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIUserKeyWithIdentity"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/keys/{key_id}":{"get":{"tags":["User keys"],"operationId":"keys.get","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_admin_pk"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIUserKey"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["User keys"],"operationId":"keys.delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_admin_pk"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/keys/{key_id}/backup":{"get":{"tags":["User keys"],"operationId":"keys.get_backup","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_admin_pk"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"put":{"tags":["User keys"],"summary":"Register or delete an encrypted backup of an existing public key.","description":"\\\nThe provided secret key should be encrypted with a passphrase. The unencrypted secret key should\\\nnever under any circumstances be uploaded to the server.\\\n\\\nUsing key backups is completely optional; all other Palform features will work as normal if your\\\nkey is not backed up. However, it is highly recommended for most users to avoid data loss.","operationId":"keys.register_backup","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_admin_pk"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterBackupKeyRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/submissions":{"post":{"tags":["Submissions"],"summary":"List the number of new responses to all forms in an organisation since a given date.","operationId":"submissions.num_since","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionCountSinceRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APISubmissionCountPerForm"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/customer":{"get":{"tags":["Billing Customers"],"operationId":"billing.customer.get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIBillingCustomer"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/customer/payment_method_update_link":{"post":{"tags":["Billing Customers"],"operationId":"billing.customer.update_payment_method","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentMethodRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/entitlements":{"get":{"tags":["Billing Entitlements"],"operationId":"billing.entitlement.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIEntitlementInfo"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/entitlements/test":{"post":{"tags":["Billing Entitlements"],"operationId":"billing.entitlement.test","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIEntitlementRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"Boolean","type":"boolean"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/invoices":{"get":{"tags":["Billing Invoices"],"operationId":"billing.invoice.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIBillingInvoice"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/invoices/next":{"get":{"tags":["Billing Invoices"],"operationId":"billing.invoice.preview","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"stripe_subscription_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIBillingUpcomingInvoice"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/plan":{"get":{"tags":["Billing Plans"],"operationId":"billing.plan.get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIBillingSubscription"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/plan/initiate":{"post":{"tags":["Billing Plans"],"operationId":"billing.plan.initiate","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiatePlanRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/plan/switch":{"post":{"tags":["Billing Plans"],"operationId":"billing.plan.switch","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"dry_run","in":"query","required":true,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPlanRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIBillingUpcomingInvoice"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/billing/plan/{stripe_subscription_id}":{"delete":{"tags":["Billing Plans"],"operationId":"billing.plan.cancel","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"stripe_subscription_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPlanRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/templates/{template_id}/clone":{"post":{"tags":["Form Templates"],"operationId":"form_templates.clone","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"template_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneFormTemplateRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIForm"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/users/service-accounts":{"post":{"tags":["Admin Users"],"summary":"Create a service account.","description":"\\\nThe service account will be added as a non-admin member of the organisation and a Viewer member\\\nof its default team. This can be changed after creation.","operationId":"admin_users.service_accounts.create","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIServiceAccountAdminUser"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/users/service-accounts/{admin_user_id}":{"delete":{"tags":["Admin Users"],"summary":"Delete a service account.","operationId":"admin_users.service_accounts.delete","parameters":[{"name":"admin_user_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/teams/my":{"get":{"tags":["Organisation Teams"],"operationId":"organisation.teams.list_my","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisationTeamMembership"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/teams":{"get":{"tags":["Organisation Teams"],"operationId":"organisation.teams.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisationTeam"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Organisation Teams"],"operationId":"organisation.teams.create","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/teams/{team_id}":{"get":{"tags":["Organisation Teams"],"operationId":"organisation.teams.get","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIOrganisationTeam"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Organisation Teams"],"operationId":"organisation.teams.delete","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/assets":{"get":{"tags":["Team Assets"],"operationId":"organisation.team.asset.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APITeamAsset"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Team Assets"],"operationId":"organisation.team.asset.upload","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APITeamAsset"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/assets/{asset_id}":{"get":{"tags":["Team Assets"],"operationId":"organisation.team.asset.get","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_tas"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/keys/all":{"get":{"tags":["Organisation Keys"],"summary":"List the fingerprints of all keys owned by all members of a team.","operationId":"org.keys.team_fingerprints","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeysTeamFingerprintsResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/members":{"get":{"tags":["Organisation Team Members"],"operationId":"organisation.team.members.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIOrganisationTeamMember"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Organisation Team Members"],"operationId":"organisation.team.members.add","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTeamMemberRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/members/{member_user_id}":{"patch":{"tags":["Organisation Team Members"],"operationId":"organisation.team.members.patch","parameters":[{"name":"member_user_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganisationTeamMembersPatchRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Organisation Team Members"],"operationId":"organisation.team.members.delete","parameters":[{"name":"member_user_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_user"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/brandings":{"get":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIFormBranding"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.create","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFormBrandingRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"String","type":"string"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/brandings/{branding_id}":{"put":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.put","parameters":[{"name":"branding_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_brand"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFormBrandingRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.delete","parameters":[{"name":"branding_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_brand"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/team/{team_id}/brandings/{branding_id}/access":{"get":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.list_access","parameters":[{"name":"branding_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_brand"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIFormBrandingAccess"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.add_access","parameters":[{"name":"branding_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_brand"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAccessRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFormBrandingAccess"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Form Brandings"],"operationId":"organisation.team.branding.delete_access","parameters":[{"name":"branding_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_brand"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"team_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_team"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAccessRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/forms":{"get":{"tags":["Forms"],"summary":"List all forms that the user has access to within an organisation.","operationId":"forms.list","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIForm"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Forms"],"summary":"Create a new form.","description":"\\\nThe form will be created in the specified team. It will not be initialised with any questions.\\\nSome settings can be updated after creation.","operationId":"forms.create","parameters":[{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIForm"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/forms/{form_id}":{"get":{"tags":["Forms"],"summary":"Get the metadata of a form.","operationId":"forms.get","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIForm"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"put":{"tags":["Forms"],"summary":"Update the metadata of a form.","operationId":"forms.update","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFormRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"delete":{"tags":["Forms"],"summary":"Deletes a form and all of its questions, question groups, submissions, settings, etc.","operationId":"forms.delete","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/forms/{form_id}/location":{"patch":{"tags":["Forms"],"summary":"Move a form to another team.","description":"\\\nThe user performing this operation must have at least Editor access to both the form's current\\\nand target teams. The form's branding will be reset to the default, since branding\\\nconfigurations are team-specific.","operationId":"forms.relocate","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsRelocateRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/forms/{form_id}/auto-delete":{"put":{"tags":["Forms"],"summary":"Configure the auto-deletion policy of a form.","description":"\\\nForms with this feature enabled will have all responses created a certain number of days ago get\\\nautomatically deleted. This is done by a scheduled job on the backend, so the time of deletion\\\nwon't be exactly `days * 24` hours after the submission is created.\\\n\\\nIf there are responses older than the configured number of days when this feature is enabled,\\\nthey will be deleted whenever the scheduled job next runs.","operationId":"forms.set_auto_delete","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetSubmissionAutoDeleteRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/forms/{form_id}/clone":{"post":{"tags":["Forms"],"summary":"Creates a copy of a form and its question groups and questions.","description":"\\\nThe copy is created in the specified team. The user calling this method must have read\\\npermissions on the form (i.e. the `Viewer` role in its team) and the `Editor` role on the team\\\ninto which the form is being copied.\\\n\\\nThe responses and the fill access tokens of the form will not be copied.","operationId":"forms.clone","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsCloneRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIForm"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/submissions":{"get":{"tags":["Submissions"],"summary":"List all changes to responses to a form.","operationId":"submissions.list","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"since","in":"query","description":"If specified, only list new changes made since this date.","required":false,"schema":{"description":"If specified, only list new changes made since this date.","allOf":[{"$ref":"#/components/schemas/TSID_sub"}],"nullable":true}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APISubmissionStream"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/submissions/assets/{file_id}":{"get":{"tags":["Submission Asset"],"operationId":"submission.assets.get_link","parameters":[{"name":"file_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_subf"}},{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"title":"uint8","type":"integer","format":"uint8","minimum":0.0}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/submissions/{submission_id}/crypto":{"get":{"tags":["Submissions"],"summary":"List all the keys that are able to decrypt a given form response.","description":"\\\nThis extracts the recipient keys of the submission's PGP message and tries to match each one to\\\na key of a known Palform user. If it succeeds, it returns the full details of the matched key.\\\nOtherwise, it just returns the key's fingerprint.","operationId":"submissions.crypto","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"submission_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_sub"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionCryptoDetailsResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/submissions/{submission_id}":{"delete":{"tags":["Submissions"],"summary":"Delete a form response.","description":"\\\nThe response will be fully deleted, but its ID and deletion time will be retained to allow\\\ntracking the fact that a submission was deleted.","operationId":"submissions.delete","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"submission_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_sub"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/content/save":{"post":{"tags":["Questions"],"summary":"Set the questions and grouos of a form.","description":"\\\nThis configures the questions, question groups, and stepping configuration for a form all in one\\\ngo. It diffs the questions and question groups you provide with the current state of the form in\\\nthe DB. It creates questions/question groups where they don't yet exist (by ID), updates their\\\nmetadata if they have changed, updates their positions if they have changed, and deletes them if\\\nthey are not in the request.\\\n\\\nTherefore, the questions and groups must be provided in full on each request. A question that\\\nexists in the form but is not sent in this request will be deleted. The comparison checking\\\nworks by ID.\\\n\\\nNote that deleted questions will be completely deleted immediately and will not be served to new\\\nrespondents. Existing responses will retain the values for deleted questions of course, since\\\nPalform can't view or edit end-to-end-encrypted response data.","operationId":"questions.save","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APISaveQuestionsRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/content/groups/all/questions":{"get":{"tags":["Questions"],"summary":"List all questions in a form.","operationId":"questions.list","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestion"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/content/groups/{question_group_id}/questions/{question_id}":{"get":{"tags":["Questions"],"summary":"Get a specific question.","operationId":"questions.get","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"question_group_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_qg"}},{"name":"question_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_qu"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIQuestion"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/groups":{"get":{"tags":["Question Groups"],"summary":"List all question groups in a form.","operationId":"question_groups.list","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestionGroup"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/webhooks":{"get":{"tags":["Webhooks"],"operationId":"webhooks.list","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIWebhook"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Webhooks"],"operationId":"webhooks.create","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/webhooks/{webhook_id}/jobs":{"get":{"tags":["Webhooks"],"operationId":"webhooks.list_jobs","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"webhook_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_wh"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIWebhookJob"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/webhooks/{webhook_id}":{"delete":{"tags":["Webhooks"],"operationId":"webhooks.delete","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"webhook_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_wh"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/fill_access_tokens":{"get":{"tags":["Fill Access Tokens"],"summary":"List all fill access tokens of a form.","operationId":"fill_access_tokens.list","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIFillToken"}}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false},"post":{"tags":["Fill Access Tokens"],"summary":"Create a new fill access token.","description":"\\\nThese tokens are included in fill URLs, which allows end-users to fill in forms. Each form can\\\nhave multiple fill access tokens, which allows segmenting submissions based on their source.","operationId":"fill_access_tokens.create","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTokenRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFillToken"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/org/{org_id}/form/{form_id}/fill_access_tokens/{token_id}":{"delete":{"tags":["Fill Access Tokens"],"summary":"Delete a fill access token.","description":"\\\nThe responses created with this token will not be deleted, but the token will be disassociated\\\nfrom them. URLs containing this token will stop working immediately.","operationId":"fill_access_tokens.delete","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}},{"name":"token_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_fat"}}],"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false}},"/api/fill/form/forms/short_link/{subdomain}/{short_link}":{"get":{"tags":["Forms"],"summary":"Resolve a short link on an organisational subdomain to an organisation ID, a form ID, and a fill","description":"token.","operationId":"forms.exchange_short_link","parameters":[{"name":"short_link","in":"path","required":true,"schema":{"description":"The form's short link path","type":"string"}},{"name":"subdomain","in":"path","required":true,"schema":{"description":"The organisation's subdomain","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIExchangedShortLink"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[]}},"/api/fill/form/forms/{form_id}/org/{org_id}":{"get":{"tags":["Forms"],"operationId":"forms.view","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIFormWithQuestions"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"api_fill_access_token":[]}]},"post":{"tags":["Forms"],"summary":"Submit a response to a form.","description":"\\\nThe submission will be associated with the fill access token.\\\n\\\nThe message is validated on the backend to ensure it is parseable before it gets saved to\\\nthe database, but of course it is not decrypted, so no validation on the underlying data is\\\nperformed.","operationId":"forms.fill","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsFillRequest"}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"api_fill_access_token":[]},{"verified_captcha":[]},{}]}},"/api/fill/form/forms/{form_id}/org/{org_id}/keys":{"get":{"tags":["Forms"],"summary":"Get a list of PGP keys that responses to a form should be encrypted with.","description":"\\\nThis will return all of the non-expired public keys of all of the users who are members of the form's team. In\\\ngeneral, responses to the form should be encrypted for all of these keys, such that any one of\\\nthem can decrypt the response.","operationId":"forms.keys","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsKeysResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"api_fill_access_token":[]}]}},"/api/fill/form/{form_id}/org/{org_id}/submission_assets":{"post":{"tags":["Submission Asset"],"operationId":"submission.assets.upload","parameters":[{"name":"form_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_form"}},{"name":"org_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TSID_org"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionAssetsUploadResponse"}}}},"400":{"description":"Bad Request"},"402":{"description":"Payment Required"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":false,"security":[{"api_fill_access_token":[]}]}}},"components":{"schemas":{"APIAdminUser":{"type":"object","required":["created_at","email","id"],"properties":{"created_at":{"type":"string","format":"date-time"},"display_name":{"type":"string","nullable":true},"email":{"type":"string"},"id":{"$ref":"#/components/schemas/TSID_user"}}},"APIAdminUserSecondAuthenticationFactor":{"title":"APIAdminUserSecondAuthenticationFactor","type":"object","required":["created_at","id","method","nickname"],"properties":{"created_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_user_2fa"},"method":{"$ref":"#/components/schemas/APIAdminUserSecondAuthenticationFactorMethod"},"nickname":{"type":"string"}}},"APIAdminUserSecondAuthenticationFactorMethod":{"type":"string","enum":["TOTP","Webauthn"]},"APIAuditLogEntry":{"title":"APIAuditLogEntry","type":"object","required":["created_at","id","target_resource_id","target_resource_parent_ids","target_resource_type","user_id","verb"],"properties":{"created_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_aul"},"note":{"type":"string","nullable":true},"target_resource_id":{"$ref":"#/components/schemas/TSID_unknown"},"target_resource_parent_ids":{"type":"array","items":{"type":"string"}},"target_resource_type":{"$ref":"#/components/schemas/AuditLogTargetResourceEnum"},"user_display_name":{"type":"string","nullable":true},"user_id":{"$ref":"#/components/schemas/TSID_user"},"verb":{"$ref":"#/components/schemas/AuditLogVerbEnum"}}},"APIBillingCurrencyResponse_for_Array_of_APIBillingPlan":{"title":"APIBillingCurrencyResponse_for_Array_of_APIBillingPlan","type":"object","required":["currency","data"],"properties":{"currency":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/APIBillingPlan"}}}},"APIBillingCustomer":{"title":"APIBillingCustomer","type":"object","properties":{"address":{"allOf":[{"$ref":"#/components/schemas/APIBillingCustomerAddress"}],"nullable":true},"default_payment_method":{"allOf":[{"$ref":"#/components/schemas/APIBillingCustomerPaymentMethod"}],"nullable":true},"email":{"type":"string","nullable":true},"entity_name":{"type":"string","nullable":true}}},"APIBillingCustomerAddress":{"type":"object","properties":{"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"state":{"type":"string","nullable":true}}},"APIBillingCustomerPaymentMethod":{"oneOf":[{"title":"Card","type":"object","required":["Card"],"properties":{"Card":{"$ref":"#/components/schemas/APIBillingCustomerPaymentMethodCard"}},"additionalProperties":false},{"title":"Other","type":"object","required":["Other"],"properties":{"Other":{"type":"string"}},"additionalProperties":false}]},"APIBillingCustomerPaymentMethodCard":{"type":"object","required":["brand","last4"],"properties":{"brand":{"type":"string"},"last4":{"type":"string"}}},"APIBillingInvoice":{"title":"APIBillingInvoice","type":"object","required":["amount","created","currency","id","status"],"properties":{"amount":{"type":"integer","format":"int64"},"created":{"type":"string","format":"date-time"},"currency":{"type":"string"},"id":{"type":"string"},"status":{"$ref":"#/components/schemas/APIBillingInvoiceStatus"},"url":{"type":"string","nullable":true}}},"APIBillingInvoiceStatus":{"type":"string","enum":["Draft","Open","Paid","Uncollectible","Void"]},"APIBillingPlan":{"type":"object","required":["currency","features","highlight","name","price_annually","price_monthly","stripe_product_id"],"properties":{"currency":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"highlight":{"type":"boolean"},"name":{"type":"string"},"price_annually":{"$ref":"#/components/schemas/APIBillingPlanPrice"},"price_monthly":{"$ref":"#/components/schemas/APIBillingPlanPrice"},"stripe_product_id":{"type":"string"}}},"APIBillingPlanPrice":{"type":"object","required":["amount","stripe_price_id"],"properties":{"amount":{"type":"integer","format":"int64"},"stripe_price_id":{"type":"string"}}},"APIBillingSubscription":{"title":"APIBillingSubscription","type":"object","required":["canceling_at_end","currency","is_trial","period_end","plan_frequency","plan_name","price","stripe_plan_price_id","stripe_plan_product_id","stripe_subscription_id"],"properties":{"canceling_at_end":{"type":"boolean"},"currency":{"type":"string"},"is_trial":{"type":"boolean"},"period_end":{"type":"string","format":"date-time"},"plan_frequency":{"$ref":"#/components/schemas/APIBillingSubscriptionFrequency"},"plan_name":{"type":"string"},"price":{"$ref":"#/components/schemas/APIBillingPlanPrice"},"stripe_plan_price_id":{"type":"string"},"stripe_plan_product_id":{"type":"string"},"stripe_subscription_id":{"type":"string"}}},"APIBillingSubscriptionFrequency":{"type":"string","enum":["Monthly","Annually"]},"APIBillingUpcomingInvoice":{"title":"APIBillingUpcomingInvoice","type":"object","required":["amount_due","currency","ending_balance","invoice_date","lines","next_payment_attempt","period_end","period_start","promotions","starting_balance","tax_amount","total_amount"],"properties":{"amount_due":{"type":"integer","format":"int64"},"currency":{"type":"string"},"ending_balance":{"type":"integer","format":"int64"},"invoice_date":{"type":"string","format":"date-time"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/APIBillingUpcomingInvoiceLine"}},"next_payment_attempt":{"type":"string","format":"date-time"},"period_end":{"type":"string","format":"date-time"},"period_start":{"type":"string","format":"date-time"},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/APIBillingUpcomingInvoicePromotion"}},"starting_balance":{"type":"integer","format":"int64"},"tax_amount":{"type":"integer","format":"int64"},"total_amount":{"type":"integer","format":"int64"}}},"APIBillingUpcomingInvoiceLine":{"type":"object","required":["name","proration","quantity","stripe_description","stripe_price_id","total_price","unit_price","unit_price_per"],"properties":{"name":{"type":"string"},"proration":{"type":"boolean"},"quantity":{"type":"integer","format":"uint64","minimum":0.0},"stripe_description":{"type":"string"},"stripe_price_id":{"type":"string"},"total_price":{"type":"integer","format":"int64"},"unit_price":{"type":"integer","format":"int64"},"unit_price_per":{"type":"integer","format":"int64"}}},"APIBillingUpcomingInvoicePromotion":{"type":"object","required":["name"],"properties":{"amount_off":{"type":"integer","format":"int64","nullable":true},"name":{"type":"string"},"percent_off":{"type":"number","format":"double","nullable":true}}},"APICountryWithCallingCode":{"title":"APICountryWithCallingCode","type":"object","required":["calling_code","flag_emoji","name"],"properties":{"calling_code":{"type":"integer","format":"uint","minimum":0.0},"flag_emoji":{"type":"string"},"name":{"type":"string"}}},"APICountryWithISOCode":{"title":"APICountryWithISOCode","type":"object","required":["iso_code","name"],"properties":{"iso_code":{"type":"string"},"name":{"type":"string"}}},"APIEntitlementInfo":{"title":"APIEntitlementInfo","type":"object","required":["audit","crypto_details","export","form_captcha","import_keys","oidc","priority_support","service_account","subdomain","submission_auto_delete"],"properties":{"audit":{"type":"boolean"},"branding_count":{"type":"integer","format":"int32","nullable":true},"crypto_details":{"type":"boolean"},"export":{"type":"boolean"},"form_captcha":{"type":"boolean"},"form_count":{"type":"integer","format":"int32","nullable":true},"import_keys":{"type":"boolean"},"oidc":{"type":"boolean"},"priority_support":{"type":"boolean"},"question_per_form_count":{"type":"integer","format":"int32","nullable":true},"response_count":{"type":"integer","format":"int32","nullable":true},"service_account":{"type":"boolean"},"subdomain":{"type":"boolean"},"submission_auto_delete":{"type":"boolean"},"team_count":{"type":"integer","format":"int32","nullable":true},"user_count":{"type":"integer","format":"int32","nullable":true}}},"APIEntitlementRequest":{"title":"APIEntitlementRequest","oneOf":[{"type":"string","enum":["UserCount","ResponseCount","FormCount","TeamCount","BrandingCount","Export","ImportKeys","Subdomain","CryptoDetails","Audit","PrioritySupport","OIDC","SubmissionAutoDelete","FormCaptcha","ServiceAccount"]},{"title":"QuestionPerFormCount","type":"object","required":["QuestionPerFormCount"],"properties":{"QuestionPerFormCount":{"$ref":"#/components/schemas/TSID_form"}},"additionalProperties":false}]},"APIExchangedShortLink":{"title":"APIExchangedShortLink","type":"object","required":["fill_token_id","form_id","org_id"],"properties":{"expires_at":{"type":"string","format":"date-time","nullable":true},"fill_token_id":{"$ref":"#/components/schemas/TSID_fat"},"form_id":{"$ref":"#/components/schemas/TSID_form"},"org_id":{"$ref":"#/components/schemas/TSID_org"}}},"APIFeedbackItem":{"title":"APIFeedbackItem","type":"object","required":["score"],"properties":{"comment":{"type":"string","nullable":true},"score":{"type":"integer","format":"int32"}}},"APIFillToken":{"title":"APIFillToken","description":"A token with which end-users can access form filling related API endpoints for a specific form only.","type":"object","required":["created_at","form_id","id","nickname"],"properties":{"created_at":{"type":"string","format":"date-time"},"expires_at":{"description":"Optionally, an expiry time after which the token will no longer work","type":"string","format":"date-time","nullable":true},"form_id":{"$ref":"#/components/schemas/TSID_form"},"id":{"$ref":"#/components/schemas/TSID_fat"},"nickname":{"description":"An internal nickname to allow segmenting submissions by fill access token","type":"string"},"short_link":{"description":"Optionally, a shortened path through which the form can be filled. This requires the organisation to have a subdomain configured. The form will be available at `https://<subdomain>.palform.app/<short_link>`. Fill access tokens with short links can still be accessed at the long path, too.","type":"string","nullable":true}}},"APIForm":{"title":"APIForm","type":"object","required":["editor_name","enable_captcha","end_configuration","id","notification_email","one_question_per_page","response_count","team_id"],"properties":{"auto_delete_submission_after_days":{"description":"Submissions are automatically deleted this number of days after submission","type":"integer","format":"int32","nullable":true},"branding_id":{"allOf":[{"$ref":"#/components/schemas/TSID_brand"}],"nullable":true},"editor_name":{"description":"A name shown only to the admins and editors of the form","type":"string"},"enable_captcha":{"description":"Whether to require a captcha to submit the form","type":"boolean"},"end_configuration":{"$ref":"#/components/schemas/APIFormEndConfiguration"},"id":{"$ref":"#/components/schemas/TSID_form"},"notification_email":{"description":"The email address to which new response notifications are sent","type":"boolean"},"notification_webhook_url":{"description":"The URL of the webhook to which new response notifications are sent","type":"string","nullable":true},"one_question_per_page":{"description":"Whether to use the One Question Per Page (OQPP) flow, where each question is on a different page and the user has to click \"Next\" to continue. Otherwise, multiple questions are allowed per page, and the form editor can decide which pages contain which questions.","type":"boolean"},"response_count":{"description":"An up-to-date count of all non-deleted responses across all fill access tokens","type":"integer","format":"int64"},"team_id":{"$ref":"#/components/schemas/TSID_team"},"title":{"description":"A public-facing name, shown only on non-OQPP forms","type":"string","nullable":true}}},"APIFormBranding":{"type":"object","required":["border_intensity","border_rounding","border_shadow_intensity","e2ee_badge","font_size","google_font","id","include_palform_attribution","name","primary_color","spacing"],"properties":{"accent_color":{"type":"string","nullable":true},"background_color":{"type":"string","nullable":true},"background_color_accent":{"type":"string","nullable":true},"background_image_asset_id":{"allOf":[{"$ref":"#/components/schemas/TSID_tas"}],"nullable":true},"border_intensity":{"$ref":"#/components/schemas/FormBrandingBorderIntensityEnum"},"border_rounding":{"$ref":"#/components/schemas/FormBrandingBorderRoundingEnum"},"border_shadow_intensity":{"$ref":"#/components/schemas/FormBrandingBorderIntensityEnum"},"e2ee_badge":{"type":"boolean"},"extra_footer_message":{"type":"string","nullable":true},"font_size":{"$ref":"#/components/schemas/FormBrandingFontSizeEnum"},"google_font":{"type":"string"},"id":{"$ref":"#/components/schemas/TSID_brand"},"include_palform_attribution":{"type":"boolean"},"logo_asset_id":{"allOf":[{"$ref":"#/components/schemas/TSID_tas"}],"nullable":true},"name":{"type":"string"},"primary_color":{"type":"string"},"privacy_link":{"type":"string","nullable":true},"spacing":{"$ref":"#/components/schemas/FormBrandingSpacingEnum"},"terms_link":{"type":"string","nullable":true}}},"APIFormBrandingAccess":{"title":"APIFormBrandingAccess","type":"object","required":["team_id","team_name"],"properties":{"team_id":{"$ref":"#/components/schemas/TSID_team"},"team_name":{"type":"string"}}},"APIFormBrandingRequest":{"title":"APIFormBrandingRequest","type":"object","required":["border_intensity","border_rounding","border_shadow_intensity","e2ee_badge","font_size","google_font","include_palform_attribution","name","primary_color","spacing"],"properties":{"accent_color":{"type":"string","nullable":true},"background_color":{"type":"string","nullable":true},"background_color_accent":{"type":"string","nullable":true},"background_image_asset_id":{"allOf":[{"$ref":"#/components/schemas/TSID_tas"}],"nullable":true},"border_intensity":{"$ref":"#/components/schemas/FormBrandingBorderIntensityEnum"},"border_rounding":{"$ref":"#/components/schemas/FormBrandingBorderRoundingEnum"},"border_shadow_intensity":{"$ref":"#/components/schemas/FormBrandingBorderIntensityEnum"},"e2ee_badge":{"type":"boolean"},"extra_footer_message":{"type":"string","nullable":true},"font_size":{"$ref":"#/components/schemas/FormBrandingFontSizeEnum"},"google_font":{"type":"string"},"include_palform_attribution":{"type":"boolean"},"logo_asset_id":{"allOf":[{"$ref":"#/components/schemas/TSID_tas"}],"nullable":true},"name":{"type":"string"},"primary_color":{"type":"string"},"privacy_link":{"type":"string","nullable":true},"spacing":{"$ref":"#/components/schemas/FormBrandingSpacingEnum"},"terms_link":{"type":"string","nullable":true}}},"APIFormEndConfiguration":{"description":"A configuration for what the page shown to the user after successfully submitting the form should look like","type":"object","required":["show_restart"],"properties":{"message":{"description":"A Markdown-enabled message to show to the user","type":"string","nullable":true},"redirect_to":{"description":"If specified, a button is shown with the text \"Continue\" that links to this URL","type":"string","nullable":true},"show_restart":{"description":"Whether to show a button to start a new submission from scratch","type":"boolean"}}},"APIFormTemplate":{"title":"APIFormTemplate","type":"object","required":["author_name","clones","description","id","name","organisation_id","preview_token","views"],"properties":{"author_name":{"type":"string"},"clones":{"type":"integer","format":"int64"},"description":{"type":"string"},"id":{"$ref":"#/components/schemas/TSID_form"},"name":{"type":"string"},"organisation_id":{"$ref":"#/components/schemas/TSID_org"},"preview_token":{"$ref":"#/components/schemas/TSID_fat"},"views":{"type":"integer","format":"int64"}}},"APIFormTemplateCategory":{"title":"APIFormTemplateCategory","type":"object","required":["id","name","template_count"],"properties":{"id":{"$ref":"#/components/schemas/TSID_tmplcat"},"name":{"type":"string"},"template_count":{"type":"integer","format":"int64"}}},"APIFormWithQuestions":{"title":"APIFormWithQuestions","description":"A full dump of all the information needed to fully display a form, in a compressed format with shortened keys.","type":"object","required":["f","g","o","q"],"properties":{"b":{"allOf":[{"$ref":"#/components/schemas/APIFormBranding"}],"nullable":true},"f":{"$ref":"#/components/schemas/APIFrontendForm"},"g":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestionGroup"}},"o":{"type":"string"},"q":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestion"}}}},"APIFrontendForm":{"description":"A stripped-down version of the form's metadata shown to non-admin users filling the form","type":"object","required":["editor_name","enable_captcha","end_configuration","id","one_question_per_page"],"properties":{"editor_name":{"type":"string"},"enable_captcha":{"type":"boolean"},"end_configuration":{"$ref":"#/components/schemas/APIFormEndConfiguration"},"id":{"$ref":"#/components/schemas/TSID_form"},"one_question_per_page":{"type":"boolean"},"title":{"type":"string","nullable":true}}},"APIGenericLocation":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"number","format":"double"},"lng":{"type":"number","format":"double"}},"additionalProperties":false},"APIOrgMemberHuman":{"title":"APIOrgMemberHuman","type":"object","required":["is_admin","organisation_id","user_email","user_id"],"properties":{"is_admin":{"type":"boolean"},"organisation_id":{"$ref":"#/components/schemas/TSID_org"},"user_display_name":{"type":"string","nullable":true},"user_email":{"type":"string"},"user_id":{"$ref":"#/components/schemas/TSID_user"}}},"APIOrgMemberServiceAccount":{"title":"APIOrgMemberServiceAccount","type":"object","required":["is_admin","organisation_id","user_created_at","user_email","user_id"],"properties":{"is_admin":{"type":"boolean"},"organisation_id":{"$ref":"#/components/schemas/TSID_org"},"user_created_at":{"type":"string","format":"date-time"},"user_email":{"type":"string"},"user_id":{"$ref":"#/components/schemas/TSID_user"}}},"APIOrganisation":{"title":"APIOrganisation","type":"object","required":["billing_allow_overage","created_at","display_name","id","uses_oidc"],"properties":{"billing_allow_overage":{"description":"Whether to allow the organisation to go over its response limit and therefore be charged for additional responses.","deprecated":true,"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"display_name":{"description":"The name of the organisation, visible to admins and anyone filling any of the organisation's forms.","type":"string"},"id":{"$ref":"#/components/schemas/TSID_org"},"subdomain":{"description":"Optionally, a subdomain used by the organisation for short form links and possibly for authentication via OIDC (if configured).","type":"string","nullable":true},"uses_oidc":{"description":"Whether the organisation uses OIDC authentication.","type":"boolean"}}},"APIOrganisationAuthConfig":{"title":"APIOrganisationAuthConfig","type":"object","required":["client_id","client_secret","oidc_discovery_url"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"oidc_discovery_url":{"type":"string"},"revoke_team_mappings":{"type":"boolean","nullable":true},"team_mapping_field_name":{"type":"string","nullable":true}}},"APIOrganisationAuthTeamMapping":{"title":"APIOrganisationAuthTeamMapping","type":"object","required":["field_value","id","role","team_id","team_name"],"properties":{"field_value":{"type":"string"},"id":{"$ref":"#/components/schemas/TSID_org_auth_team_map"},"role":{"$ref":"#/components/schemas/OrganisationMemberRoleEnum"},"team_id":{"$ref":"#/components/schemas/TSID_team"},"team_name":{"type":"string"}}},"APIOrganisationAuthTeamMappingRequest":{"title":"APIOrganisationAuthTeamMappingRequest","type":"object","required":["field_value","role","team_id"],"properties":{"field_value":{"type":"string"},"role":{"$ref":"#/components/schemas/OrganisationMemberRoleEnum"},"team_id":{"$ref":"#/components/schemas/TSID_team"}}},"APIOrganisationDeletionRequest":{"title":"APIOrganisationDeletionRequest","type":"object","required":["created_at","deletion_at","id","include_user","organisation_id","reason","status","user_id"],"properties":{"created_at":{"type":"string","format":"date-time"},"deletion_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_org_delete"},"include_user":{"type":"boolean"},"organisation_id":{"$ref":"#/components/schemas/TSID_org"},"reason":{"$ref":"#/components/schemas/CancelPlanRequestReason"},"status":{"$ref":"#/components/schemas/OrganisationDeletionRequestStatusEnum"},"user_id":{"$ref":"#/components/schemas/TSID_user"}}},"APIOrganisationInvite":{"title":"APIOrganisationInvite","type":"object","required":["created_at","expires_at","id","single_use"],"properties":{"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_org_invite"},"single_use":{"type":"boolean"}}},"APIOrganisationInvitePreview":{"title":"APIOrganisationInvitePreview","type":"object","required":["expires_at","org_display_name","org_id"],"properties":{"expires_at":{"type":"string","format":"date-time"},"org_display_name":{"type":"string"},"org_id":{"$ref":"#/components/schemas/TSID_org"}}},"APIOrganisationManifest":{"title":"APIOrganisationManifest","type":"object","required":["active_subscriptions","audit_log_count","branding_count","form_count","member_count","question_count","submission_count","team_asset_count","team_count"],"properties":{"active_subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/APIBillingSubscription"}},"audit_log_count":{"type":"integer","format":"uint64","minimum":0.0},"branding_count":{"type":"integer","format":"uint64","minimum":0.0},"form_count":{"type":"integer","format":"uint64","minimum":0.0},"member_count":{"type":"integer","format":"uint64","minimum":0.0},"question_count":{"type":"integer","format":"uint64","minimum":0.0},"submission_count":{"type":"integer","format":"uint64","minimum":0.0},"team_asset_count":{"type":"integer","format":"uint64","minimum":0.0},"team_count":{"type":"integer","format":"uint64","minimum":0.0}}},"APIOrganisationTeam":{"title":"APIOrganisationTeam","type":"object","required":["id","name","num_members","organisation_id"],"properties":{"id":{"$ref":"#/components/schemas/TSID_team"},"is_default":{"type":"boolean","nullable":true},"name":{"type":"string"},"num_members":{"type":"integer","format":"int64"},"organisation_id":{"$ref":"#/components/schemas/TSID_org"}}},"APIOrganisationTeamMember":{"title":"APIOrganisationTeamMember","type":"object","required":["role","user_email","user_id"],"properties":{"role":{"$ref":"#/components/schemas/OrganisationMemberRoleEnum"},"user_display_name":{"type":"string","nullable":true},"user_email":{"type":"string"},"user_id":{"$ref":"#/components/schemas/TSID_user"}}},"APIOrganisationTeamMembership":{"title":"APIOrganisationTeamMembership","type":"object","required":["my_role","name","team_id"],"properties":{"my_role":{"$ref":"#/components/schemas/OrganisationMemberRoleEnum"},"name":{"type":"string"},"team_id":{"$ref":"#/components/schemas/TSID_team"}}},"APIQuestion":{"type":"object","required":["configuration","group_id","id","required","title"],"properties":{"configuration":{"$ref":"#/components/schemas/APIQuestionConfiguration"},"description":{"description":"A Markdown-enabled description shown below the title.","type":"string","nullable":true},"group_id":{"$ref":"#/components/schemas/TSID_qg"},"id":{"$ref":"#/components/schemas/TSID_qu"},"internal_name":{"description":"The name of the field as used in bulk submission exports and recall tags.","type":"string","nullable":true},"required":{"description":"Whether to prevent the question group being finished if this question has not been answered. Each question type has a different definition of what it means to be answered.","type":"boolean"},"title":{"type":"string"}}},"APIQuestionConfiguration":{"oneOf":[{"title":"config_info","description":"A purely informational non-interactive question that serves as (e.g.) a section heading.","type":"object","required":["info"],"properties":{"info":{"type":"object","properties":{"background_color":{"deprecated":true,"type":"string","nullable":true}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_text","type":"object","required":["text"],"properties":{"text":{"type":"object","required":["is_long"],"properties":{"is_long":{"description":"Will use a textarea instead of an input","type":"boolean"},"validator":{"description":"Use client-side validation to ensure a valid input. Not validated server-side due to encryption, so this doesn't guarantee valid data.","allOf":[{"$ref":"#/components/schemas/APIQuestionTextValidator"}],"nullable":true}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_choice","type":"object","required":["choice"],"properties":{"choice":{"type":"object","required":["multi","options"],"properties":{"multi":{"description":"Support multiple options in a submission (i.e. checkboxes instead of radio buttons)","type":"boolean"},"options":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_scale","type":"object","required":["scale"],"properties":{"scale":{"type":"object","required":["max","min"],"properties":{"icon":{"default":"Numeric","allOf":[{"$ref":"#/components/schemas/APIQuestionScaleIcon"}]},"max":{"type":"integer","format":"int32"},"max_label":{"type":"string","nullable":true},"min":{"type":"integer","format":"int32"},"min_label":{"type":"string","nullable":true}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_address","type":"object","required":["address"],"properties":{"address":{"type":"object","properties":{"search_centre":{"description":"Weights the auto-complete suggestions to prefer a specific location","allOf":[{"$ref":"#/components/schemas/APIGenericLocation"}],"nullable":true}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_phone_number","type":"object","required":["phone_number"],"properties":{"phone_number":{"type":"object","properties":{"allowed_calling_codes":{"description":"Only shows these calling codes. Empty list (default) means all codes allowed.","default":[],"type":"array","items":{"type":"string"}},"default_calling_code":{"description":"Pre-selects this calling code","default":null,"type":"string","nullable":true}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_file_upload","type":"object","required":["file_upload"],"properties":{"file_upload":{"type":"object","required":["allowed_types"],"properties":{"allowed_types":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestionFileUploadType"}}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_signature","type":"object","required":["signature"],"properties":{"signature":{"type":"object","required":["allow_freeform","allow_full_name","allow_initial"],"properties":{"allow_freeform":{"type":"boolean"},"allow_full_name":{"type":"boolean"},"allow_initial":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_choice_matrix","type":"object","required":["choice_matrix"],"properties":{"choice_matrix":{"type":"object","required":["columns","multi_cols","rows"],"properties":{"columns":{"type":"array","items":{"type":"string"}},"multi_cols":{"type":"boolean"},"rows":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_date_time","type":"object","required":["date_time"],"properties":{"date_time":{"type":"object","required":["collect_date","collect_time"],"properties":{"collect_date":{"type":"boolean"},"collect_time":{"type":"boolean"},"max":{"type":"string","format":"date-time","nullable":true},"min":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_rank","type":"object","required":["rank"],"properties":{"rank":{"type":"object","required":["default_random","options"],"properties":{"default_random":{"description":"If true, will show the items ranked randomly instead of the default order.","type":"boolean"},"options":{"description":"Available options to be ranked by the user. Will be shown in the specified order.","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},{"title":"config_hidden","type":"object","required":["hidden"],"properties":{"hidden":{"type":"object","required":["parameter_name"],"properties":{"parameter_name":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}]},"APIQuestionFileUploadType":{"type":"string","enum":["Image","Video","Document","Slideshow","Spreadsheet","Any"]},"APIQuestionGroup":{"description":"A question group corresponds to a page.\n\nOn a one-question-per-page form, each group contains exactly one question, since each question is on its own page. On non-OQPP forms, each group can contain any number of questions. When filling the form, the user will have to click \"Next\" to continue to the next question group.","type":"object","required":["id","step_strategy"],"properties":{"description":{"description":"A user-facing description. Only shown on non-OQPP forms.","type":"string","nullable":true},"id":{"$ref":"#/components/schemas/TSID_qg"},"step_strategy":{"$ref":"#/components/schemas/APIQuestionGroupStepStrategy"},"title":{"description":"A user-facing title. Only shown on non-OQPP forms.","type":"string","nullable":true}}},"APIQuestionGroupStepStrategy":{"description":"A strategy to determine what to do after the user has filled a question group.","oneOf":[{"title":"NextPosition","description":"Continue to the group with the next `position`. This is the default option.","type":"string","enum":["NextPosition"]},{"title":"JumpToSection","description":"Jump to one of a list of sections. Each jump case is evaluated one-by-one in order, and the first one to match will be selected as the next question group to take the user to. If none of them match, the action will be to submit the form. Specifying an empty list here will mean that the action is always to submit the form.","type":"object","required":["JumpToSection"],"properties":{"JumpToSection":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestionGroupStepStrategyJumpCase"}}},"additionalProperties":false}]},"APIQuestionGroupStepStrategyJumpCase":{"type":"object","required":["conditions"],"properties":{"conditions":{"$ref":"#/components/schemas/APIQuestionGroupStepStrategyJumpCaseConditionList"},"target_group_id":{"description":"If Some(uuid) jump to the group with that `uuid`. If None, submit the form.","allOf":[{"$ref":"#/components/schemas/TSID_qg"}],"nullable":true}}},"APIQuestionGroupStepStrategyJumpCaseCondition":{"type":"object","required":["matcher","question_id"],"properties":{"matcher":{"$ref":"#/components/schemas/APIQuestionGroupStepStrategyJumpCaseConditionMatcher"},"question_id":{"$ref":"#/components/schemas/TSID_qu"}}},"APIQuestionGroupStepStrategyJumpCaseConditionList":{"oneOf":[{"title":"Or","description":"The case matches if any of these conditions match","type":"object","required":["Or"],"properties":{"Or":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestionGroupStepStrategyJumpCaseCondition"}}},"additionalProperties":false},{"title":"And","description":"The case matches if all of these conditions match","type":"object","required":["And"],"properties":{"And":{"type":"array","items":{"$ref":"#/components/schemas/APIQuestionGroupStepStrategyJumpCaseCondition"}}},"additionalProperties":false}]},"APIQuestionGroupStepStrategyJumpCaseConditionMatcher":{"oneOf":[{"title":"matcher_choice","description":"A single- or multi- choice question exactly matches this _set_ of items (regardless of order)","type":"object","required":["Choice"],"properties":{"Choice":{"type":"object","required":["contains_any","options"],"properties":{"contains_any":{"type":"boolean"},"options":{"type":"array","items":{"type":"string"}}}}},"additionalProperties":false},{"title":"matcher_text","type":"object","required":["Text"],"properties":{"Text":{"type":"object","required":["case_sensitive","contains","value"],"properties":{"case_sensitive":{"type":"boolean"},"contains":{"description":"Checks exact match if false, otherwise checks whether the value is contained","type":"boolean"},"value":{"type":"string"}}}},"additionalProperties":false},{"title":"matcher_scale","type":"object","required":["Scale"],"properties":{"Scale":{"type":"object","required":["direction","value"],"properties":{"direction":{"$ref":"#/components/schemas/DirectionOperator"},"value":{"type":"integer","format":"int32"}}}},"additionalProperties":false},{"title":"matcher_phone_number","type":"object","required":["PhoneNumber"],"properties":{"PhoneNumber":{"type":"object","required":["calling_code"],"properties":{"calling_code":{"type":"string"}}}},"additionalProperties":false},{"title":"matcher_address","type":"object","required":["Address"],"properties":{"Address":{"type":"object","properties":{"in_country":{"type":"string","nullable":true},"near":{"allOf":[{"$ref":"#/components/schemas/APIGenericLocation"}],"nullable":true},"near_radius_km":{"type":"number","format":"double","nullable":true}}}},"additionalProperties":false},{"title":"matcher_choice_matrix","type":"object","required":["ChoiceMatrix"],"properties":{"ChoiceMatrix":{"type":"object","required":["column","row"],"properties":{"column":{"type":"string"},"row":{"type":"string"}}}},"additionalProperties":false},{"title":"matcher_date_time","type":"object","required":["DateTime"],"properties":{"DateTime":{"type":"object","required":["direction","match_date","match_time","value"],"properties":{"direction":{"$ref":"#/components/schemas/DirectionOperator"},"match_date":{"type":"boolean"},"match_time":{"type":"boolean"},"value":{"type":"string","format":"date-time"}}}},"additionalProperties":false},{"title":"matcher_hidden","type":"object","required":["Hidden"],"properties":{"Hidden":{"type":"object","required":["value"],"properties":{"value":{"type":"string"}}}},"additionalProperties":false}]},"APIQuestionScaleIcon":{"type":"string","enum":["Numeric","Stars","Hearts","Thumbs"]},"APIQuestionTextValidator":{"type":"string","enum":["Email","Integer","Float"]},"APISaveQuestionsRequest":{"title":"APISaveQuestionsRequest","type":"object","required":["groups","questions"],"properties":{"groups":{"description":"The full list of question groups.","type":"array","items":{"$ref":"#/components/schemas/APIQuestionGroup"}},"questions":{"description":"The full list of questions. Their group ID must be one of the specified groups.","type":"array","items":{"$ref":"#/components/schemas/APIQuestion"}}}},"APIServiceAccountAdminUser":{"title":"APIServiceAccountAdminUser","type":"object","required":["created_at","email","id"],"properties":{"created_at":{"type":"string","format":"date-time"},"email":{"type":"string"},"id":{"$ref":"#/components/schemas/TSID_user"},"service_account_auth_token":{"description":"The service account's token, to be used as a bearer credential when making API requests. Only returned once when the service account is created.","type":"string","nullable":true}}},"APISubmission":{"type":"object","required":["created_at","data","id"],"properties":{"created_at":{"type":"string","format":"date-time"},"data":{"description":"The submission data as an encrypted PGP message in armored ASCII form. The message itself is a JSON object of the form `[palform_client_common::form_management::submission::InProgressSubmission]`.","type":"string"},"for_token":{"description":"The fill access token that the user used to fill out the form","allOf":[{"$ref":"#/components/schemas/TSID_fat"}],"nullable":true},"id":{"$ref":"#/components/schemas/TSID_sub"}}},"APISubmissionCountPerForm":{"title":"APISubmissionCountPerForm","type":"object","required":["form_id","new_submission_count","team_id"],"properties":{"form_id":{"$ref":"#/components/schemas/TSID_form"},"new_submission_count":{"type":"integer","format":"int64"},"team_id":{"$ref":"#/components/schemas/TSID_team"}}},"APISubmissionStream":{"title":"APISubmissionStream","type":"object","required":["deleted","new","total"],"properties":{"deleted":{"description":"IDs of submissions that were deleted","type":"array","items":{"$ref":"#/components/schemas/TSID_sub"}},"new":{"description":"New submissions","type":"array","items":{"$ref":"#/components/schemas/APISubmission"}},"since":{"description":"If requested, the date since which the changes cover","allOf":[{"$ref":"#/components/schemas/TSID_sub"}],"nullable":true},"total":{"description":"The total number of non-deleted submissions to the form (over all time, regardless of `since`)","type":"integer","format":"uint64","minimum":0.0}}},"APITeamAsset":{"title":"APITeamAsset","type":"object","required":["created_at","id","url"],"properties":{"created_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_tas"},"url":{"type":"string"}}},"APIUserKey":{"title":"APIUserKey","description":"A backend representation of a user's encryption key.","type":"object","required":["created_at","expires_at","has_backup","id","key_pem","user_id"],"properties":{"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"has_backup":{"description":"Whether the key is backed up to the DB in encrypted form","type":"boolean"},"id":{"type":"string"},"key_pem":{"description":"PGP public key in ASCII-armored form","type":"string"},"user_id":{"type":"string"}}},"APIUserKeyWithIdentity":{"type":"object","required":["created_at","expires_at","id","key_fingerprint","user_email","user_id"],"properties":{"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_admin_pk"},"key_fingerprint":{"type":"string"},"user_display_name":{"type":"string","nullable":true},"user_email":{"type":"string"},"user_id":{"$ref":"#/components/schemas/TSID_user"}}},"APIWebhook":{"title":"APIWebhook","type":"object","required":["created_at","endpoint","form_id","id","is_healthy"],"properties":{"created_at":{"type":"string","format":"date-time"},"endpoint":{"type":"string"},"form_id":{"$ref":"#/components/schemas/TSID_form"},"id":{"$ref":"#/components/schemas/TSID_wh"},"is_healthy":{"type":"boolean"}}},"APIWebhookJob":{"title":"APIWebhookJob","type":"object","required":["id"],"properties":{"done_at":{"type":"string","format":"date-time","nullable":true},"error":{"type":"string","nullable":true},"id":{"$ref":"#/components/schemas/TSID_whj"},"retries":{"type":"integer","format":"int32","nullable":true}}},"AddAccessRequest":{"title":"AddAccessRequest","type":"object","required":["for_team_id"],"properties":{"for_team_id":{"$ref":"#/components/schemas/TSID_team"}}},"AddTeamMemberRequest":{"title":"AddTeamMemberRequest","type":"object","required":["role","user_ids"],"properties":{"role":{"$ref":"#/components/schemas/OrganisationMemberRoleEnum"},"user_ids":{"type":"array","items":{"$ref":"#/components/schemas/TSID_user"}}}},"AlertResponse":{"title":"AlertResponse","type":"object","required":["alert_type","hide_on"],"properties":{"alert_type":{"$ref":"#/components/schemas/AlertType"},"hide_on":{"type":"array","items":{"$ref":"#/components/schemas/HideContext"}}}},"AlertType":{"type":"string","enum":["NoActiveKey","PendingDeletion"]},"AuditLogTargetResourceEnum":{"type":"string","enum":["OrganisationMember","Team","TeamMember","Form","Branding","OrganisationAuthConfig","OrganisationSubdomain","Organisation","AuthSession","Submission","AdminPublicKey"]},"AuditLogVerbEnum":{"type":"string","enum":["Create","Read","Update","Delete"]},"AuthCallbackRequest":{"title":"AuthCallbackRequest","type":"object","required":["auth_code","nonce","redirect_url"],"properties":{"auth_code":{"description":"The authorization code provided in response from the OIDC provider","type":"string"},"nonce":{"description":"The nonce provided when starting the auth flow","type":"string"},"redirect_url":{"description":"The redirect URL set by the client when starting the auth flow","type":"string"}}},"AuthCallbackResponse":{"title":"AuthCallbackResponse","type":"object","required":["is_new","token"],"properties":{"is_new":{"type":"boolean"},"token":{"$ref":"#/components/schemas/NewAPIAuthToken"}}},"AuthTestResponse":{"title":"AuthTestResponse","type":"object","required":["token_id","user"],"properties":{"token_id":{"type":"string"},"user":{"$ref":"#/components/schemas/APIAdminUser"}}},"CancelPlanRequest":{"title":"CancelPlanRequest","type":"object","required":["reason"],"properties":{"reason":{"$ref":"#/components/schemas/CancelPlanRequestReason"}}},"CancelPlanRequestReason":{"type":"string","enum":["CustomerService","LowQuality","MissingFeatures","Other","SwitchedService","TooComplex","TooExpensive","Unused"]},"CloneFormTemplateRequest":{"title":"CloneFormTemplateRequest","type":"object","required":["into_team"],"properties":{"into_team":{"$ref":"#/components/schemas/TSID_team"}}},"CreateFormRequest":{"title":"CreateFormRequest","type":"object","required":["editor_name","in_team","one_question_per_page","title"],"properties":{"branding_id":{"description":"The branding to use. Will use Palform's default look if no branding is provided.","allOf":[{"$ref":"#/components/schemas/TSID_brand"}],"nullable":true},"editor_name":{"description":"A name shown only to the admins and editors of the form","type":"string"},"in_team":{"description":"The team to create the form in","allOf":[{"$ref":"#/components/schemas/TSID_team"}]},"one_question_per_page":{"description":"Whether to use the One Question Per Page (OQPP) flow, where each question is on a different page and the user has to click \"Next\" to continue. Otherwise, multiple questions are allowed per page, and the form editor can decide which pages contain which questions. This cannot be changed after the form is created.","type":"boolean"},"title":{"description":"A public-facing name, shown only on non-OQPP forms","type":"string"}}},"CreateSubdomainRequest":{"title":"CreateSubdomainRequest","type":"object","required":["subdomain"],"properties":{"subdomain":{"type":"string","maxLength":20,"minLength":3}}},"CreateTeamRequest":{"title":"CreateTeamRequest","type":"object","required":["name"],"properties":{"name":{"type":"string"}}},"CreateUserRequest":{"title":"CreateUserRequest","type":"object","required":["email","password"],"properties":{"email":{"type":"string"},"password":{"type":"string","maxLength":64,"minLength":12}}},"CreateWebhookRequest":{"title":"CreateWebhookRequest","type":"object","required":["endpoint"],"properties":{"endpoint":{"type":"string","format":"uri"}}},"CreateWebhookResponse":{"title":"CreateWebhookResponse","type":"object","required":["id","signing_secret"],"properties":{"id":{"$ref":"#/components/schemas/TSID_wh"},"signing_secret":{"type":"string"}}},"DecrpytingKey":{"oneOf":[{"title":"Known","description":"The key was matched to a Palform user","type":"object","required":["Known"],"properties":{"Known":{"$ref":"#/components/schemas/APIUserKeyWithIdentity"}},"additionalProperties":false},{"title":"Unknown","description":"The key was not matched to a Palform user, so only its fingerprint is known","type":"object","required":["Unknown"],"properties":{"Unknown":{"type":"string"}},"additionalProperties":false}]},"DeleteAccessRequest":{"title":"DeleteAccessRequest","type":"object","required":["for_team_id"],"properties":{"for_team_id":{"$ref":"#/components/schemas/TSID_team"}}},"DirectionOperator":{"type":"string","enum":["GreaterThan","GreaterThanEqualTo","LessThan","LessThanEqualTo","Equal"]},"EnrollTOTPRequest":{"title":"EnrollTOTPRequest","type":"object","required":["nickname","secret"],"properties":{"nickname":{"type":"string","maxLength":30,"minLength":1},"secret":{"type":"string"}}},"EnrollWebauthnRequest":{"title":"EnrollWebauthnRequest","type":"object","required":["cred","nickname","session"],"properties":{"cred":{"type":"string"},"nickname":{"type":"string"},"session":{"$ref":"#/components/schemas/TSID_user_2fa_sess"}}},"FormBrandingBorderIntensityEnum":{"type":"string","enum":["Off","Low","Medium","High"]},"FormBrandingBorderRoundingEnum":{"type":"string","enum":["None","Small","Medium","Large"]},"FormBrandingFontSizeEnum":{"type":"string","enum":["Tiny","Small","Regular","Large","VeryLarge"]},"FormBrandingSpacingEnum":{"type":"string","enum":["Tight","Normal","Comfy"]},"FormsCloneRequest":{"title":"FormsCloneRequest","type":"object","required":["new_team_id"],"properties":{"new_team_id":{"description":"The team to place the new form into.","allOf":[{"$ref":"#/components/schemas/TSID_team"}]}}},"FormsFillRequest":{"title":"FormsFillRequest","type":"object","required":["data"],"properties":{"data":{"description":"The submission data as an encrypted PGP message in armored ASCII form. The message itself must be a JSON object of the form `[palform_client_common::form_management::submission::InProgressSubmission]`.","type":"string"}}},"FormsKeysResponse":{"title":"FormsKeysResponse","type":"object","required":["keys"],"properties":{"keys":{"description":"A list of PGP public keys in armored ASCII form","type":"array","items":{"type":"string"}}}},"FormsRelocateRequest":{"title":"FormsRelocateRequest","type":"object","required":["target_team_id"],"properties":{"target_team_id":{"description":"The team to move the form to.","allOf":[{"$ref":"#/components/schemas/TSID_team"}]}}},"HideContext":{"type":"string","enum":["Induction","Keys"]},"InductionStatus":{"title":"InductionStatus","type":"object","required":["can_create_invite","form_created","induction_complete","invite_created","key_created"],"properties":{"can_create_invite":{"type":"boolean"},"form_created":{"type":"boolean"},"induction_complete":{"type":"boolean"},"invite_created":{"type":"boolean"},"key_created":{"type":"boolean"}}},"InitiatePlanRequest":{"title":"InitiatePlanRequest","type":"object","required":["stripe_plan_price_id","success_url","trial"],"properties":{"stripe_plan_price_id":{"type":"string"},"success_url":{"type":"string"},"trial":{"type":"boolean"}}},"JoinOrganisationRequest":{"title":"JoinOrganisationRequest","type":"object","required":["invite_id"],"properties":{"invite_id":{"$ref":"#/components/schemas/TSID_org_invite"}}},"KeysTeamFingerprintsResponse":{"title":"KeysTeamFingerprintsResponse","type":"object","required":["fingerprints"],"properties":{"fingerprints":{"type":"array","items":{"type":"string"}}}},"ListSocialAuthProvidersResponse":{"title":"ListSocialAuthProvidersResponse","type":"object","required":["available_providers"],"properties":{"available_providers":{"type":"array","items":{"$ref":"#/components/schemas/SocialAuthService"}}}},"Map_of_AnyValue":{"title":"Map_of_AnyValue","type":"object","additionalProperties":true},"NewAPIAuthToken":{"type":"object","required":["expires_at","id","secret"],"properties":{"expires_at":{"type":"string","format":"date-time"},"id":{"$ref":"#/components/schemas/TSID_au"},"secret":{"type":"string"}}},"NewOrganisationInviteRequest":{"title":"NewOrganisationInviteRequest","type":"object","required":["expires_in_seconds","single_use"],"properties":{"expires_in_seconds":{"type":"integer","format":"uint32","minimum":0.0},"single_use":{"type":"boolean"}}},"NewOrganisationRequest":{"title":"NewOrganisationRequest","type":"object","required":["display_name"],"properties":{"display_name":{"type":"string","maxLength":40,"minLength":1}}},"NewTokenRequest":{"title":"NewTokenRequest","type":"object","required":["nickname"],"properties":{"expires_in_seconds":{"description":"Optionally, an expiry time after which the token will no longer work","type":"integer","format":"uint32","minimum":0.0,"nullable":true},"nickname":{"description":"An internal nickname to allow segmenting submissions by fill access token","type":"string"},"short_link":{"description":"Optionally, a shortened path through which the form can be filled. This requires the organisation to have a subdomain configured. The form will be available at `https://<subdomain>.palform.app/<short_link>`. Fill access tokens with short links can still be accessed at the long path, too.","type":"string","nullable":true}}},"OrganisationDeletionRequestStatusEnum":{"type":"string","enum":["GracePeriod","Paused","Deleted","Cancelled"]},"OrganisationMemberRoleEnum":{"type":"string","enum":["Viewer","Editor","Admin"]},"OrganisationTeamMembersPatchRequest":{"title":"OrganisationTeamMembersPatchRequest","type":"object","required":["new_role"],"properties":{"new_role":{"$ref":"#/components/schemas/OrganisationMemberRoleEnum"}}},"OrganisationsDeleteRequest":{"title":"OrganisationsDeleteRequest","type":"object","required":["dry_run","include_own_account","reason"],"properties":{"dry_run":{"type":"boolean"},"include_own_account":{"type":"boolean"},"reason":{"$ref":"#/components/schemas/CancelPlanRequestReason"}}},"PatchOrgMemberRequest":{"title":"PatchOrgMemberRequest","type":"object","required":["is_admin"],"properties":{"is_admin":{"type":"boolean"}}},"PatchOrgRequest":{"title":"PatchOrgRequest","type":"object","required":["display_name"],"properties":{"display_name":{"description":"The name of the organisation, visible to admins and anyone filling any of the organisation's forms.","type":"string","maxLength":40,"minLength":1}}},"RegisterBackupKeyRequest":{"title":"RegisterBackupKeyRequest","type":"object","properties":{"key_data":{"description":"PEM-encoded encrypted secret key (`null` to delete the existing backup)","type":"string","nullable":true}}},"RegisterKeyRequest":{"title":"RegisterKeyRequest","type":"object","required":["key_data"],"properties":{"key_data":{"description":"PEM-encoded public key","type":"string"}}},"ResendVerificationRequest":{"title":"ResendVerificationRequest","type":"object","required":["email"],"properties":{"email":{"type":"string"}}},"ResetPasswordRequest":{"title":"ResetPasswordRequest","type":"object","required":["new_password","verification_id"],"properties":{"new_password":{"type":"string","maxLength":64,"minLength":12},"verification_id":{"$ref":"#/components/schemas/TSID_user_email_verification"}}},"SendPasswordResetRequest":{"title":"SendPasswordResetRequest","type":"object","required":["email"],"properties":{"email":{"type":"string"}}},"SetSubmissionAutoDeleteRequest":{"title":"SetSubmissionAutoDeleteRequest","type":"object","properties":{"days":{"description":"The number of days, or `null` to disable this feature for this form.","type":"integer","format":"int32","nullable":true}}},"SignInRequest":{"title":"SignInRequest","type":"object","required":["create_initial_org","email","password"],"properties":{"create_initial_org":{"type":"boolean"},"email":{"type":"string"},"password":{"type":"string"}}},"SignInResponse":{"title":"SignInResponse","oneOf":[{"title":"Done","type":"object","required":["Done"],"properties":{"Done":{"type":"object","required":["token"],"properties":{"new_org_id":{"allOf":[{"$ref":"#/components/schemas/TSID_org"}],"nullable":true},"token":{"$ref":"#/components/schemas/NewAPIAuthToken"}}}},"additionalProperties":false},{"title":"SecondFactorRequired","type":"object","required":["SecondFactorRequired"],"properties":{"SecondFactorRequired":{"type":"object","required":["session_id","totp"],"properties":{"new_org_id":{"allOf":[{"$ref":"#/components/schemas/TSID_org"}],"nullable":true},"rcr":{"type":"string","nullable":true},"session_id":{"$ref":"#/components/schemas/TSID_user_2fa_sess"},"totp":{"type":"boolean"}}}},"additionalProperties":false}]},"SocialAuthCallbackRequest":{"title":"SocialAuthCallbackRequest","type":"object","required":["code","nonce","redirect_url","service"],"properties":{"code":{"type":"string"},"nonce":{"type":"string"},"redirect_url":{"type":"string"},"service":{"$ref":"#/components/schemas/SocialAuthService"}}},"SocialAuthCallbackResponse":{"title":"SocialAuthCallbackResponse","type":"object","required":["token"],"properties":{"new_org_id":{"allOf":[{"$ref":"#/components/schemas/TSID_org"}],"nullable":true},"token":{"$ref":"#/components/schemas/NewAPIAuthToken"}}},"SocialAuthService":{"type":"string","enum":["Google"]},"StartAuthResponse":{"title":"StartAuthResponse","type":"object","required":["nonce","state","url"],"properties":{"nonce":{"type":"string"},"state":{"description":"Make sure you verify the state returned in the callback is identical to this state value","type":"string"},"url":{"type":"string"}}},"StartSocialAuthRequest":{"title":"StartSocialAuthRequest","type":"object","required":["redirect_url","service"],"properties":{"redirect_url":{"type":"string"},"service":{"$ref":"#/components/schemas/SocialAuthService"}}},"StartSocialAuthResponse":{"title":"StartSocialAuthResponse","type":"object","required":["nonce","state","url"],"properties":{"nonce":{"type":"string"},"state":{"type":"string"},"url":{"type":"string"}}},"StartWebauthnResponse":{"title":"StartWebauthnResponse","type":"object","required":["ccr","session"],"properties":{"ccr":{"type":"string"},"session":{"$ref":"#/components/schemas/TSID_user_2fa_sess"}}},"StripeSignature":{"title":"StripeSignature","type":"string"},"SubmissionAssetsUploadResponse":{"title":"SubmissionAssetsUploadResponse","type":"object","required":["file_id"],"properties":{"file_id":{"$ref":"#/components/schemas/TSID_subf"}}},"SubmissionCountSinceRequest":{"title":"SubmissionCountSinceRequest","type":"object","required":["since"],"properties":{"since":{"type":"string","format":"date-time"}}},"SubmissionCryptoDetailsResponse":{"title":"SubmissionCryptoDetailsResponse","type":"object","required":["decrypting_keys"],"properties":{"decrypting_keys":{"type":"array","items":{"$ref":"#/components/schemas/DecrpytingKey"}}}},"SwitchPlanRequest":{"title":"SwitchPlanRequest","type":"object","required":["new_stripe_price_id"],"properties":{"new_stripe_price_id":{"type":"string"}}},"TSID_admin_pk":{"type":"string"},"TSID_au":{"type":"string"},"TSID_aul":{"type":"string"},"TSID_brand":{"type":"string"},"TSID_fat":{"type":"string"},"TSID_form":{"type":"string"},"TSID_org":{"type":"string"},"TSID_org_auth_team_map":{"type":"string"},"TSID_org_delete":{"type":"string"},"TSID_org_invite":{"type":"string"},"TSID_qg":{"type":"string"},"TSID_qu":{"type":"string"},"TSID_sub":{"type":"string"},"TSID_subf":{"type":"string"},"TSID_tas":{"type":"string"},"TSID_team":{"type":"string"},"TSID_tmplcat":{"type":"string"},"TSID_unknown":{"type":"string"},"TSID_user":{"type":"string"},"TSID_user_2fa":{"type":"string"},"TSID_user_2fa_sess":{"type":"string"},"TSID_user_email_verification":{"type":"string"},"TSID_wh":{"type":"string"},"TSID_whj":{"type":"string"},"UpdateAdminUserRequest":{"title":"UpdateAdminUserRequest","type":"object","properties":{"display_name":{"type":"string","maxLength":40,"minLength":1,"nullable":true}}},"UpdateFormRequest":{"title":"UpdateFormRequest","type":"object","required":["editor_name","enable_captcha","end_configuration","notification_email"],"properties":{"branding_id":{"allOf":[{"$ref":"#/components/schemas/TSID_brand"}],"nullable":true},"editor_name":{"type":"string"},"enable_captcha":{"type":"boolean"},"end_configuration":{"$ref":"#/components/schemas/APIFormEndConfiguration"},"notification_email":{"type":"boolean"},"title":{"type":"string","nullable":true}}},"UpdatePaymentMethodRequest":{"title":"UpdatePaymentMethodRequest","type":"object","required":["redirect_url"],"properties":{"redirect_url":{"type":"string"}}},"VerifyTFARequest":{"title":"VerifyTFARequest","type":"object","required":["factor","session_id"],"properties":{"factor":{"$ref":"#/components/schemas/VerifyTFASecondFactorRequest"},"session_id":{"$ref":"#/components/schemas/TSID_user_2fa_sess"}}},"VerifyTFASecondFactorRequest":{"oneOf":[{"title":"Totp","type":"object","required":["Totp"],"properties":{"Totp":{"type":"string"}},"additionalProperties":false},{"title":"Webauthn","type":"object","required":["Webauthn"],"properties":{"Webauthn":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false}]}},"securitySchemes":{"api_fill_access_token":{"type":"apiKey","name":"f","in":"query"},"personal_token":{"type":"http","scheme":"basic","description":"Only for Palform's internal requests from its own frontend"},"service_account_token":{"type":"http","scheme":"bearer","description":"Service account tokens created for your organisation"},"verified_captcha":{"type":"apiKey","name":"X-Captcha-Response","in":"header"}}},"security":[{"personal_token":[]},{"service_account_token":[]}]}