# Arb Platform

## Docs

- [Associate transaction with case](https://docs.platform.arb.inc/api-reference/_internal/associate-transaction-with-case.md): Associates a transaction with a case ID and optional party ID after creation. This is primarily used for case creation where the charge happens before the case exists. Requires billing.transactions.creator permission.
- [Regenerate document analysis](https://docs.platform.arb.inc/api-reference/analysis/regenerate-document-analysis.md): Manually triggers re-analysis of a docketed document, bypassing idempotency checks. Requires `admin.platform.super` permission.
- [Confirm arbitrator assignment](https://docs.platform.arb.inc/api-reference/arbitrators/confirm-arbitrator-assignment.md): Confirms a previously reserved arbitrator assignment, making it permanent. This endpoint transitions a temporary reservation into a confirmed assignment that will not expire. Requires `roster.arbitrators.assigner` permission.
- [Release arbitrator reservation](https://docs.platform.arb.inc/api-reference/arbitrators/release-arbitrator-reservation.md): Releases an arbitrator reservation back to the available pool, allowing the arbitrator to be assigned to other cases. Use this when a reservation is no longer needed. Requires `roster.arbitrators.assigner` permission.
- [Reserve an available arbitrator](https://docs.platform.arb.inc/api-reference/arbitrators/reserve-an-available-arbitrator.md): Reserves an available arbitrator for a case, creating a temporary hold that will expire if not confirmed. The system automatically selects an arbitrator from the available pool. Requires `roster.arbitrators.assigner` permission.
- [Create a ZIP from cloud files](https://docs.platform.arb.inc/api-reference/archives/create-a-zip-from-cloud-files.md): Takes a list of Google Cloud Storage file URLs and creates a compressed ZIP archive containing those files. The ZIP is streamed directly back to the requester without being stored on disk. Requires `zip.archive.creator` permission.
- [Authenticate a service account](https://docs.platform.arb.inc/api-reference/authenticate/authenticate-a-service-account.md): Authenticates a service account using a GCP service account ID token, returning an access token with embedded role information for service-to-service communication.
- [Authenticate with email and password](https://docs.platform.arb.inc/api-reference/authenticate/authenticate-with-email-and-password.md): Authenticates a user using their email address and password, returning an access token and refresh token for subsequent API requests. The email must be verified before authentication can succeed.
- [Authenticate with Google OAuth](https://docs.platform.arb.inc/api-reference/authenticate/authenticate-with-google-oauth.md): Authenticates a user using a Google OAuth ID token, returning an access token and refresh token for subsequent API requests. The email must be verified before authentication can succeed.
- [Create or update award prompt](https://docs.platform.arb.inc/api-reference/award-prompts/create-or-update-award-prompt.md): Creates or updates an award prompt for a specific rule set. Requires `arbitrators.award-prompts.writer` permission.
- [Delete award prompt](https://docs.platform.arb.inc/api-reference/award-prompts/delete-award-prompt.md): Deletes an award prompt for a specific rule set. Requires `arbitrators.award-prompts.writer` permission.
- [List all award prompts](https://docs.platform.arb.inc/api-reference/award-prompts/list-all-award-prompts.md): Retrieves a list of all award prompts across all rule sets. Requires `arbitrators.award-prompts.reader` permission.
- [View award prompt for rule set](https://docs.platform.arb.inc/api-reference/award-prompts/view-award-prompt-for-rule-set.md): Retrieves the award prompt for a specific rule set. Requires `arbitrators.award-prompts.reader` permission.
- [Get AI-generated award](https://docs.platform.arb.inc/api-reference/award/get-ai-generated-award.md): Retrieves the AI-generated award for a specific case. The requesting user must be the arbitrator assigned to the case.
- [Get current balance](https://docs.platform.arb.inc/api-reference/balance/get-current-balance.md): Retrieves the current credit and dollar balance for the authenticated user or organization. Balance is determined automatically from the authentication token.
- [Confirm case manager assignment](https://docs.platform.arb.inc/api-reference/case-managers/confirm-case-manager-assignment.md): Confirms a previously reserved case manager assignment, making it permanent. This endpoint transitions a temporary reservation into a confirmed assignment that will not expire. Requires `roster.case_managers.assigner` permission.
- [Release case manager reservation](https://docs.platform.arb.inc/api-reference/case-managers/release-case-manager-reservation.md): Releases a case manager reservation back to the available pool, allowing the case manager to be assigned to other cases. Use this when a reservation is no longer needed. Requires `roster.case_managers.assigner` permission.
- [Reserve an available case manager](https://docs.platform.arb.inc/api-reference/case-managers/reserve-an-available-case-manager.md): Reserves an available case manager for a case, creating a temporary hold that will expire if not confirmed. The system automatically selects a case manager from the available pool. Requires `roster.case_managers.assigner` permission.
- [Get AI-generated case summary](https://docs.platform.arb.inc/api-reference/case-summary/get-ai-generated-case-summary.md): Retrieves the AI-generated executive case summary for a specific case. The requesting user must be the arbitrator assigned to the case.
- [Get AI-generated case timeline](https://docs.platform.arb.inc/api-reference/case-timeline/get-ai-generated-case-timeline.md): Retrieves the AI-generated factual timeline for a specific case. The requesting user must be the arbitrator assigned to the case.
- [Create a new case](https://docs.platform.arb.inc/api-reference/cases/create-a-new-case.md): Creates a new arbitration case with the specified ruleset and participant details. Charges the organization for case creation and returns the case ID and title upon success.
- [Export case to ZIP archive](https://docs.platform.arb.inc/api-reference/cases/export-case-to-zip-archive.md): Exports all case documents and evidence files into a compressed ZIP archive for download. The ZIP is streamed directly back to the requester.
- [List user's cases](https://docs.platform.arb.inc/api-reference/cases/list-users-cases.md): Returns a list of all active and closed cases that the authenticated user is associated with, including participant details and current phase information.
- [View case details](https://docs.platform.arb.inc/api-reference/cases/view-case-details.md): Returns comprehensive information about a specific case including participants, timetable, settlement details, and current phase. Only available to case participants.
- [Process a charge](https://docs.platform.arb.inc/api-reference/charge/process-a-charge.md): Processes a charge against a balance for specified SKUs with idempotency support. The charge can be processed in credits or dollars depending on the useCredits flag. Requires billing.transactions.creator permission.
- [Confirm credit purchase](https://docs.platform.arb.inc/api-reference/checkout/confirm-credit-purchase.md): Verifies that a Stripe payment succeeded and adds the purchased credits to the user's balance. This endpoint should be called after the payment is confirmed on the frontend.
- [Create credit purchase intent](https://docs.platform.arb.inc/api-reference/checkout/create-credit-purchase-intent.md): Creates a Stripe PaymentIntent for purchasing credits. Returns a client secret that should be passed to Stripe.js for payment confirmation.
- [Get AI-generated claims and counterclaims](https://docs.platform.arb.inc/api-reference/claims-counterclaims/get-ai-generated-claims-and-counterclaims.md): Retrieves the AI-generated analysis of claims and counterclaims for a specific case. The requesting user must be the arbitrator assigned to the case.
- [Generate synthetic statement of claim](https://docs.platform.arb.inc/api-reference/demo/generate-synthetic-statement-of-claim.md): Generates a synthetic (test) statement of claim document for Vanguard Parking Solutions. Always uses predefined claimant information and creates realistic parking dispute scenarios for platform testing.
- [Generate synthetic statement of response](https://docs.platform.arb.inc/api-reference/demo/generate-synthetic-statement-of-response.md): Generates a synthetic (test) statement of response document written in plain, non-legal language as if from an average person responding to a parking dispute claim. The response addresses the provided statement of claim in conversational, informal style.
- [Get interactive web push demo page](https://docs.platform.arb.inc/api-reference/demo/get-interactive-web-push-demo-page.md): Returns an HTML page that demonstrates web push notification functionality. This demo allows users to register for push notifications and send test notifications to verify the subscription.
- [Get service worker JavaScript](https://docs.platform.arb.inc/api-reference/demo/get-service-worker-javascript.md): Returns the service worker JavaScript code required for the demo page to handle push notifications. This script listens for push events and displays notifications to the user.
- [Download docket entry PDF](https://docs.platform.arb.inc/api-reference/docket/download-docket-entry-pdf.md): Generates a signed URL to download the PDF file for a specific docket entry. The URL is valid for a limited time.
- [Get Statement of Claim](https://docs.platform.arb.inc/api-reference/docket/get-statement-of-claim.md): Returns the Statement of Claim document filed by the claimant, including all field values and metadata.
- [List docket entries](https://docs.platform.arb.inc/api-reference/docket/list-docket-entries.md): Returns a chronological list of all docket entries for a specific case. Only available to case participants.
- [List all published OpenAPI specifications](https://docs.platform.arb.inc/api-reference/documentation/list-all-published-openapi-specifications.md): Retrieves all published OpenAPI specifications from all platform services, sorted by service name. Returns the complete YAML content along with creation and update timestamps. Requires `devtools.documentation.viewer` permission.
- [Retrieve sent email HTML](https://docs.platform.arb.inc/api-reference/email/retrieve-sent-email-html.md): Looks up a sent email by its idempotency key and returns the rendered HTML content. This is used to archive service-of-notice emails as PDF evidence. Requires `emails.email.sender` permission.
- [Delete evidence upload](https://docs.platform.arb.inc/api-reference/evidence/delete-evidence-upload.md): Deletes an undocketed evidence upload. Evidence that has been made public cannot be deleted.
- [Download evidence file](https://docs.platform.arb.inc/api-reference/evidence/download-evidence-file.md): Generates a signed URL to download an evidence file from cloud storage. The URL is valid for a limited time.
- [List evidence uploads](https://docs.platform.arb.inc/api-reference/evidence/list-evidence-uploads.md): Returns a list of all evidence files uploaded by the user's party for the specified case.
- [Make evidence public](https://docs.platform.arb.inc/api-reference/evidence/make-evidence-public.md): Adds an evidence upload to the case docket and makes it accessible to all parties. This action cannot be undone.
- [Update evidence description](https://docs.platform.arb.inc/api-reference/evidence/update-evidence-description.md): Updates the description of an undocketed evidence upload. Evidence that has been made public cannot be updated.
- [Upload evidence file](https://docs.platform.arb.inc/api-reference/evidence/upload-evidence-file.md): Creates a new evidence upload for the case. Returns a signed URL for uploading the file content to cloud storage.
- [Approve filed document](https://docs.platform.arb.inc/api-reference/filings/approve-filed-document.md): Approves a document submission and adds it to the case docket. Requires approval permission for the party.
- [Create document filing](https://docs.platform.arb.inc/api-reference/filings/create-document-filing.md): Creates a new document filing for a case. The document is initially in draft status and must be submitted for approval before being added to the docket.
- [Delete document filing](https://docs.platform.arb.inc/api-reference/filings/delete-document-filing.md): Deletes a document filing that has not yet been submitted for approval. Submitted documents cannot be deleted.
- [Download document PDF](https://docs.platform.arb.inc/api-reference/filings/download-document-pdf.md): Generates a signed URL to download the PDF file for a specific filed document. The URL is valid for a limited time.
- [Generate document from evidence](https://docs.platform.arb.inc/api-reference/filings/generate-document-from-evidence.md): Uses AI to generate a document filing based on uploaded evidence files. Returns the generated document fields.
- [List filed documents](https://docs.platform.arb.inc/api-reference/filings/list-filed-documents.md): Returns a list of all documents filed by the authenticated user's party for the specified case.
- [List pending approvals](https://docs.platform.arb.inc/api-reference/filings/list-pending-approvals.md): Returns a list of documents awaiting approval from the authenticated user. Only shows documents the user has permission to approve.
- [Submit document for approval](https://docs.platform.arb.inc/api-reference/filings/submit-document-for-approval.md): Submits a filed document for approval and docketing. Once submitted, the document cannot be edited or deleted.
- [Update document filing](https://docs.platform.arb.inc/api-reference/filings/update-document-filing.md): Updates the field values of a document filing that has not yet been submitted. Submitted documents cannot be updated.
- [View document filing details](https://docs.platform.arb.inc/api-reference/filings/view-document-filing-details.md): Returns detailed information about a specific filed document including all field values and metadata.
- [Withdraw document approval](https://docs.platform.arb.inc/api-reference/filings/withdraw-document-approval.md): Withdraws a document that has been submitted for approval but not yet docketed. Cannot withdraw documents already added to the docket.
- [Generate arbitration award](https://docs.platform.arb.inc/api-reference/generate-award/generate-arbitration-award.md): Analyzes case docket documents and exhibits to generate an arbitration award with outcome determination and detailed reasoning. Processes multiple file types from Google Cloud Storage and applies AI analysis to all submitted materials.
- [Generate document field values from evidence](https://docs.platform.arb.inc/api-reference/generate-document/generate-document-field-values-from-evidence.md): Extracts and generates document field values from provided evidence files using AI and document type schemas. Supports optional reference documents for context and can populate complex document structures based on evidence analysis.
- [Get basic service information](https://docs.platform.arb.inc/api-reference/get-basic-service-information.md): Returns a plain text welcome message with the service name and creation date.
- [Get service information](https://docs.platform.arb.inc/api-reference/get-service-information.md): Returns basic information about the webhooks service, including creation date and author.
- [Send HTML email](https://docs.platform.arb.inc/api-reference/html/send-html-email.md): Sends an email with raw HTML content and queues it for delivery. Accepts full HTML markup with optional plain text fallback. Requires `emails.email.sender` permission.
- [Get all case files](https://docs.platform.arb.inc/api-reference/internal/get-all-case-files.md): Returns all files in a case's docket including documents and evidence. Requires cases.files.viewer permission.
- [Get case for invite code](https://docs.platform.arb.inc/api-reference/internal/get-case-for-invite-code.md): Returns case information associated with an invite code. Requires cases.case.viewer permission.
- [Get email addresses for user IDs](https://docs.platform.arb.inc/api-reference/internal/get-email-addresses-for-user-ids.md): Retrieves email addresses for multiple user IDs in a single request. Returns null for users that do not exist. Requires `auth.email.viewer` permission.
- [Get files for AI analysis](https://docs.platform.arb.inc/api-reference/internal/get-files-for-ai-analysis.md): Returns all evidence and document files for a case formatted for AI analysis. Requires cases.files.viewer permission.
- [Get full user profiles](https://docs.platform.arb.inc/api-reference/internal/get-full-user-profiles.md): Returns full profile data including first name and last name for specified user IDs. This endpoint is for internal use and requires `profiles.profiles.viewer` permission. Maximum 1000 user IDs per request.
- [Get users in an organization](https://docs.platform.arb.inc/api-reference/internal/get-users-in-an-organization.md): Returns all user IDs belonging to a specific organization. Requires `auth.organization_users.viewer` permission.
- [Proxy requests to internal endpoints](https://docs.platform.arb.inc/api-reference/internal/proxy-requests-to-internal-endpoints.md): Routes requests from the public API to internal auth service endpoints by extracting the user token from the X-Forwarded-Authorization header. Requires `api.internal.proxy` permission.
- [Route public API requests](https://docs.platform.arb.inc/api-reference/internal/route-public-api-requests.md): Routes requests from the public API gateway to internal case endpoints. Requires api.internal.proxy permission.
- [Send web push notification to subscription](https://docs.platform.arb.inc/api-reference/internal/send-web-push-notification-to-subscription.md): Sends a web push notification to a specific subscription by ID. This endpoint is used internally by other services to deliver notifications to user browsers. Requires `push.notifications.creator` permission.
- [Update case analysis](https://docs.platform.arb.inc/api-reference/internal/update-case-analysis.md): Updates AI-generated analysis data for a case. Requires cases.analysis.writer permission.
- [Accept case invite](https://docs.platform.arb.inc/api-reference/invites/accept-case-invite.md): Accepts an invitation to join a case as a participant. The authenticated user will be added to the case with the appropriate party role.
- [Download docket PDF via invite](https://docs.platform.arb.inc/api-reference/invites/download-docket-pdf-via-invite.md): Generates a signed URL to download a docket entry PDF using an invite code. Allows viewing documents without authentication.
- [Download evidence via invite](https://docs.platform.arb.inc/api-reference/invites/download-evidence-via-invite.md): Generates a signed URL to download an evidence file using an invite code. Allows viewing evidence without authentication.
- [View case via invite](https://docs.platform.arb.inc/api-reference/invites/view-case-via-invite.md): Returns case details accessible via an invite code without requiring authentication. Allows prospective participants to view case information before accepting the invite.
- [Get AI-generated key issues](https://docs.platform.arb.inc/api-reference/key-issues/get-ai-generated-key-issues.md): Retrieves the AI-generated key issues analysis for a specific case. The requesting user must be the arbitrator assigned to the case.
- [List all rulesets](https://docs.platform.arb.inc/api-reference/list/list-all-rulesets.md): Returns all available rulesets with their metadata. By default, only active rulesets are returned. Set inactive=true to include inactive rulesets.
- [Create a mailing request](https://docs.platform.arb.inc/api-reference/mailings/create-a-mailing-request.md): Creates a mailing with PDF attachment to be delivered to a recipient address. Accepts a multipart form with mailing parameters and PDF file. Requires postal.mail.sender permission.
- [Get rules as markdown](https://docs.platform.arb.inc/api-reference/markdown/get-rules-as-markdown.md): Returns the full text of a ruleset's rules in markdown format. The markdown content can be rendered or processed by the client.
- [Render markdown to a PDF](https://docs.platform.arb.inc/api-reference/markdown/render-markdown-to-a-pdf.md): Takes markdown text and returns a rendered PDF file.
- [Accept an organization invitation](https://docs.platform.arb.inc/api-reference/organizations/accept-an-organization-invitation.md): Accepts a pending invitation to join an organization, adding the authenticated user as a member of that organization.
- [Cancel an organization invitation](https://docs.platform.arb.inc/api-reference/organizations/cancel-an-organization-invitation.md): Cancels a pending invitation that was sent to a user, removing it from the system. Only the sender or organization admin can cancel invitations.
- [Create a new organization](https://docs.platform.arb.inc/api-reference/organizations/create-a-new-organization.md): Creates a new organization for the authenticated user. Users are limited to creating 2 organizations to prevent abuse.
- [Decline an organization invitation](https://docs.platform.arb.inc/api-reference/organizations/decline-an-organization-invitation.md): Declines a pending invitation to join an organization, removing the invitation from the system.
- [Get organization public profiles](https://docs.platform.arb.inc/api-reference/organizations/get-organization-public-profiles.md): Returns public profile data for organizations by organization IDs. Maximum 1000 organization IDs per request. This endpoint returns only publicly visible information.
- [Invite a user to an organization](https://docs.platform.arb.inc/api-reference/organizations/invite-a-user-to-an-organization.md): Invites a user to join an organization via email. The authenticated user must be logged into an organization context to send invites.
- [List organization members](https://docs.platform.arb.inc/api-reference/organizations/list-organization-members.md): Lists all users who are members of a specific organization. Requires the authenticated user to be a member of the organization.
- [List pending invitations](https://docs.platform.arb.inc/api-reference/organizations/list-pending-invitations.md): Lists all pending organization invitations for the authenticated user, including invitations they have received but not yet accepted or declined.
- [List user's organizations](https://docs.platform.arb.inc/api-reference/organizations/list-users-organizations.md): Lists all organizations that the authenticated user is a member of, including when they joined and who invited them.
- [Add participant to case](https://docs.platform.arb.inc/api-reference/participants/add-participant-to-case.md): Adds a participant from your organization to an existing case. The participant will have the same party role as the requester.
- [Get rules as PDF](https://docs.platform.arb.inc/api-reference/pdf/get-rules-as-pdf.md): Returns the full text of a ruleset's rules as a PDF file. The PDF is retrieved from cloud storage and streamed back to the client.
- [Get timetable phases](https://docs.platform.arb.inc/api-reference/phases/get-timetable-phases.md): Returns the phases array from a ruleset's timetable configuration. Each phase defines the allowed documents, duration, and advancement rules for that stage of the case.
- [Render a pleading to PDF](https://docs.platform.arb.inc/api-reference/pleadings/render-a-pleading-to-pdf.md): Fills a pleading document and returns a PDF.
- [List user alert preferences](https://docs.platform.arb.inc/api-reference/preferences/list-user-alert-preferences.md): Retrieves all alert preferences for the authenticated user, including settings for docket filings and case creation notifications. Returns each preference with its current value, type, title, and description.
- [Update user alert preferences](https://docs.platform.arb.inc/api-reference/preferences/update-user-alert-preferences.md): Updates alert preferences for the authenticated user. Allows users to control which types of notifications they receive, such as alerts for docket filings or case creation events.
- [Look up SKU pricing](https://docs.platform.arb.inc/api-reference/pricing/look-up-sku-pricing.md): Looks up current pricing information for one or more SKU codes. Supports both single SKU lookup and batch lookup of up to 50 SKUs.
- [Process generic AI query](https://docs.platform.arb.inc/api-reference/process/process-generic-ai-query.md): Processes generic AI queries with optional Google Cloud Storage file attachments and returns AI-generated text responses. Supports multiple AI models and can analyze various file types. Requires `ai.agent.user` permission.
- [Create AI analysis prompt](https://docs.platform.arb.inc/api-reference/prompts/create-ai-analysis-prompt.md): Creates a new prompt configuration for AI document analysis. Defines when and how AI should analyze specific document types in cases. Requires `admin.platform.super` permission.
- [List AI analysis prompts](https://docs.platform.arb.inc/api-reference/prompts/list-ai-analysis-prompts.md): Returns all AI analysis prompts, optionally filtered by document type or rule set. Requires `admin.platform.super` permission.
- [Update AI analysis prompt](https://docs.platform.arb.inc/api-reference/prompts/update-ai-analysis-prompt.md): Updates an existing prompt configuration by ID. Allows modification of prompt text and trigger settings. Requires `admin.platform.super` permission.
- [View AI analysis prompt](https://docs.platform.arb.inc/api-reference/prompts/view-ai-analysis-prompt.md): Returns the active prompt configuration for a specific document type and rule set combination. Requires `admin.platform.super` permission.
- [Register response portal user for case alerts](https://docs.platform.arb.inc/api-reference/register/register-response-portal-user-for-case-alerts.md): Registers a response portal user to receive case alerts by associating their push subscription ID with a specific case using an invite code. This allows external users to receive notifications about case activity.
- [Create a new ruleset](https://docs.platform.arb.inc/api-reference/rulesets/create-a-new-ruleset.md): Creates a new ruleset with its rules, PDF document, and default timetable. The markdown content is automatically converted to PDF and stored in cloud storage. Requires rules.rule_sets.creator permission.
- [List case schemas](https://docs.platform.arb.inc/api-reference/schemas/list-case-schemas.md): Returns all available schemas for parties, phases, documents, and evidence categories used in case creation and management.
- [Attest manual service delivery](https://docs.platform.arb.inc/api-reference/service-of-notice/attest-manual-service-delivery.md): Accepts manual delivery attestation for service of notice. Used when service is delivered in person or through other non-tracked methods.
- [Create manual service code](https://docs.platform.arb.inc/api-reference/service-of-notice/create-manual-service-code.md): Creates a code for manual service of notice delivery. The code can be shared with the respondent for self-attestation.
- [Create service attachment](https://docs.platform.arb.inc/api-reference/service-of-notice/create-service-attachment.md): Creates a webpage screenshot attachment to include with a service of notice mailing.
- [Create service mailing](https://docs.platform.arb.inc/api-reference/service-of-notice/create-service-mailing.md): Creates a mailing to deliver service of notice to a respondent via postal mail. The mailing will be processed and sent by the postal service.
- [List available mail types](https://docs.platform.arb.inc/api-reference/service-of-notice/list-available-mail-types.md): Returns all available mail types for service of notice delivery including their customizable fields and requirements.
- [List service attempts](https://docs.platform.arb.inc/api-reference/service-of-notice/list-service-attempts.md): Returns all service-of-notice attempts for a case including method, status, timestamps, and linked document IDs. The caller must be a participant on the case.
- [List service mailings](https://docs.platform.arb.inc/api-reference/service-of-notice/list-service-mailings.md): Returns a list of all service of notice mailings for a case including their delivery status.
- [Preview service mailing](https://docs.platform.arb.inc/api-reference/service-of-notice/preview-service-mailing.md): Generates a preview PDF of the mailing content including all attachments before sending. Allows verification of formatting and content.
- [Send service via email](https://docs.platform.arb.inc/api-reference/service-of-notice/send-service-via-email.md): Sends service of notice to a respondent via email. The email will include case details and instructions for responding.
- [View service attempt](https://docs.platform.arb.inc/api-reference/service-of-notice/view-service-attempt.md): Returns detailed information about a specific service-of-notice attempt including delivery status and linked filings. The caller must be a participant on the case.
- [Attach roles to session](https://docs.platform.arb.inc/api-reference/sessions/attach-roles-to-session.md): Attaches user roles to the current session for authorization by validating a TOTP passcode. Roles remain attached until the session expires.
- [Logout and terminate session](https://docs.platform.arb.inc/api-reference/sessions/logout-and-terminate-session.md): Terminates the current user session and invalidates the refresh token, preventing further access token generation.
- [Refresh access token](https://docs.platform.arb.inc/api-reference/sessions/refresh-access-token.md): Exchanges a refresh token for a new access token without requiring reauthentication. The access token includes any roles that were previously attached to the session.
- [Switch active organization](https://docs.platform.arb.inc/api-reference/sessions/switch-active-organization.md): Switches the active organization context for the current session. The user must be a member of the organization to switch to it.
- [List SKUs in group](https://docs.platform.arb.inc/api-reference/skus/list-skus-in-group.md): Lists all active SKUs in a specified group with their pricing information. Groups are logical collections of related SKUs.
- [Get AI-generated summary of positions](https://docs.platform.arb.inc/api-reference/summary-of-positions/get-ai-generated-summary-of-positions.md): Retrieves the AI-generated summary of party positions for a specific case. The requesting user must be the arbitrator assigned to the case.
- [List all tasks](https://docs.platform.arb.inc/api-reference/tasks/list-all-tasks.md): Returns all pending tasks the authenticated user can complete across all cases they are involved in.
- [List case tasks](https://docs.platform.arb.inc/api-reference/tasks/list-case-tasks.md): Returns all pending tasks the authenticated user can complete for a specific case.
- [Send templated email](https://docs.platform.arb.inc/api-reference/template/send-templated-email.md): Sends an email using a Resend template with dynamic variables and queues it for delivery. Templates are managed in the Resend dashboard. Requires `emails.email.sender` permission.
- [Fill a PDF from a template](https://docs.platform.arb.inc/api-reference/templates/fill-a-pdf-from-a-template.md): Fills a PDF using a specified template and placeholder values.
- [List available templates](https://docs.platform.arb.inc/api-reference/templates/list-available-templates.md): Returns a list of templates the current user can access.
- [Render a PDF from a template with optional files and JSON data](https://docs.platform.arb.inc/api-reference/templates/render-a-pdf-from-a-template-with-optional-files-and-json-data.md): Renders a PDF using a template, placeholder values, optional uploaded files, and optional JSON data. **Multipart parts** (order not strict): 1. `documentID` (text, required), 2. `placeholders` (JSON; may be `{}`), 3. zero or more file parts named `file.<fieldName>` (PNG images), 4. zero or more data…
- [Upload a PDF template](https://docs.platform.arb.inc/api-reference/templates/upload-a-pdf-template.md): Uploads a PDF file as a template for a given document.
- [Upload an HTML template](https://docs.platform.arb.inc/api-reference/templates/upload-an-html-template.md): Uploads HTML and CSS as a template for a given document. Templates are stored in the database and rendered to PDF using Chrome.
- [Get timetable schemas](https://docs.platform.arb.inc/api-reference/timetables/get-timetable-schemas.md): Returns schemas for parties, documents, and phases that can be used in procedural timetables.
- [Replace case timetable](https://docs.platform.arb.inc/api-reference/timetables/replace-case-timetable.md): Replaces the existing procedural timetable for a case with a new one. This updates all phase deadlines and requirements.
- [View case timetable](https://docs.platform.arb.inc/api-reference/timetables/view-case-timetable.md): Returns the complete procedural timetable for a case including all phases, deadlines, and requirements.
- [List transaction history](https://docs.platform.arb.inc/api-reference/transactions/list-transaction-history.md): Lists transaction history for the authenticated user or organization with pagination support. Supports filtering by transaction type, case ID, and party ID.
- [Delete a registered webhook URL](https://docs.platform.arb.inc/api-reference/urls/delete-a-registered-webhook-url.md): Removes a webhook URL from the organization's registered endpoints. Once deleted, the URL will no longer receive event notifications from the platform.
- [List all registered webhook URLs](https://docs.platform.arb.inc/api-reference/urls/list-all-registered-webhook-urls.md): Retrieves all webhook URLs currently registered for the authenticated organization. Returns metadata including registration timestamp and the user who registered each URL.
- [Register a new webhook URL](https://docs.platform.arb.inc/api-reference/urls/register-a-new-webhook-url.md): Registers a webhook URL to receive real-time notifications about platform events such as case closures, docket filings, and phase changes. The URL must be publicly accessible and respond to POST requests.
- [Send a test webhook to verify URL configuration](https://docs.platform.arb.inc/api-reference/urls/send-a-test-webhook-to-verify-url-configuration.md): Sends a test POST request to a registered webhook URL to verify connectivity and proper configuration. Returns the HTTP status code and response body from the webhook endpoint.
- [Confirm email address](https://docs.platform.arb.inc/api-reference/users/confirm-email-address.md): Confirms a user's email address using a verification code sent via email. The account must be verified before authentication is allowed.
- [Create account with email and password](https://docs.platform.arb.inc/api-reference/users/create-account-with-email-and-password.md): Creates a new user account using email and password credentials. Password must meet minimum strength requirements and terms of service must be accepted.
- [Create account with Google OAuth](https://docs.platform.arb.inc/api-reference/users/create-account-with-google-oauth.md): Creates a new user account using Google OAuth credentials. The Google ID token is validated and the email is automatically verified.
- [Create TOTP credential](https://docs.platform.arb.inc/api-reference/users/create-totp-credential.md): Creates a new TOTP secret for two-factor authentication. Returns the secret and configuration details needed to set up an authenticator app.
- [Get user public profiles](https://docs.platform.arb.inc/api-reference/users/get-user-public-profiles.md): Returns public profile data including first name and last name for specified user IDs. Maximum 1000 user IDs per request. This endpoint returns only publicly visible information.
- [List user roles](https://docs.platform.arb.inc/api-reference/users/list-user-roles.md): Lists all roles assigned to the authenticated user across all organizations they belong to.
- [Read TOTP configuration](https://docs.platform.arb.inc/api-reference/users/read-totp-configuration.md): Retrieves the user's TOTP configuration details including usage statistics. Does not return the secret itself.
- [Reset account password](https://docs.platform.arb.inc/api-reference/users/reset-account-password.md): Resets a user's password using a verification code sent via email. The new password must meet minimum strength requirements.
- [Send email verification code](https://docs.platform.arb.inc/api-reference/users/send-email-verification-code.md): Sends a verification code to the user's email address for email confirmation. Codes are rate-limited to prevent abuse.
- [Send password reset code](https://docs.platform.arb.inc/api-reference/users/send-password-reset-code.md): Sends a verification code to the user's email address for password reset. Codes are rate-limited to prevent abuse.
- [Create new VAPID key pair](https://docs.platform.arb.inc/api-reference/vapid-keys/create-new-vapid-key-pair.md): Generates a new VAPID key pair and stores it encrypted in the database using Cloud KMS. VAPID keys are required for web push authentication. Requires `push.keys.creator` permission.
- [Get current active VAPID public key](https://docs.platform.arb.inc/api-reference/vapid-keys/get-current-active-vapid-public-key.md): Returns the current active VAPID public key that browsers should use when subscribing to push notifications. This key is needed to establish the web push subscription.
- [Send test notification to verify subscription](https://docs.platform.arb.inc/api-reference/web-push/send-test-notification-to-verify-subscription.md): Sends a test push notification to verify that a subscription is working correctly. This is useful for testing after registration to ensure the browser can receive notifications.
- [Subscribe to web push with authentication](https://docs.platform.arb.inc/api-reference/web-push/subscribe-to-web-push-with-authentication.md): Registers an authenticated user's browser for web push notifications. The subscription is bound to the user's session and organization. Returns a subscription ID that can be used to send notifications to this user.
- [Subscribe to web push without authentication](https://docs.platform.arb.inc/api-reference/web-push/subscribe-to-web-push-without-authentication.md): Registers a browser for web push notifications without requiring user authentication. Returns a subscription ID that can be used to send notifications to this browser.
- [Receive Resend webhook events](https://docs.platform.arb.inc/api-reference/webhooks/receive-resend-webhook-events.md): Receives real-time email delivery events from Resend via webhook. Updates email tracking records and publishes events to Pub/Sub for delivered, bounced, and sent emails. This endpoint is called directly by Resend's webhook system.
- [Home](https://docs.platform.arb.inc/index.md): Modern arbitration platform for efficient dispute resolution

## OpenAPI Specs

- [cases](https://docs.platform.arb.inc/api-reference/cases.yaml)
- [api](https://docs.platform.arb.inc/api-reference/api.yaml)
- [zip](https://docs.platform.arb.inc/api-reference/zip.yaml)
- [webshot](https://docs.platform.arb.inc/api-reference/webshot.yaml)
- [webhooks](https://docs.platform.arb.inc/api-reference/webhooks.yaml)
- [rules](https://docs.platform.arb.inc/api-reference/rules.yaml)
- [roster](https://docs.platform.arb.inc/api-reference/roster.yaml)
- [push](https://docs.platform.arb.inc/api-reference/push.yaml)
- [profiles](https://docs.platform.arb.inc/api-reference/profiles.yaml)
- [postal](https://docs.platform.arb.inc/api-reference/postal.yaml)
- [emails](https://docs.platform.arb.inc/api-reference/emails.yaml)
- [devtools](https://docs.platform.arb.inc/api-reference/devtools.yaml)
- [billing](https://docs.platform.arb.inc/api-reference/billing.yaml)
- [auth](https://docs.platform.arb.inc/api-reference/auth.yaml)
- [arbitrators](https://docs.platform.arb.inc/api-reference/arbitrators.yaml)
- [alerts](https://docs.platform.arb.inc/api-reference/alerts.yaml)
- [ai](https://docs.platform.arb.inc/api-reference/ai.yaml)
- [pdfs](https://docs.platform.arb.inc/api-reference/pdfs.yaml)
- [openapi](https://docs.platform.arb.inc/api-reference/openapi.json)

## Optional

- [Open App](https://app.arb.inc)
- [API Status](https://status.arb.inc)