{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Togai documentation","colors":{"primary":"#2853C2","light":"#2563EB","dark":"#2563EB"},"favicon":"/images/togai-logo-light.svg","logo":{"light":"https://mintcdn.com/zuora-togai/gpDI_SmUijp8C7vA/images/togai-light.png?fit=max\u0026auto=format\u0026n=gpDI_SmUijp8C7vA\u0026q=85\u0026s=f564a808b1f89a7be82bef2effbcbeea","dark":"https://mintcdn.com/zuora-togai/gpDI_SmUijp8C7vA/images/togai-dark.svg?fit=max\u0026auto=format\u0026n=gpDI_SmUijp8C7vA\u0026q=85\u0026s=32fc4951a4bf9381284ec120bc163c72"},"api":{"openapi":["openapi.yaml"],"playground":{"display":"simple"},"mdx":{"server":["https://sandbox-api.togai.com","https://api.togai.com"],"auth":{"method":"bearer","name":null}}},"background":{"image":"https://mintlify.s3.us-west-1.amazonaws.com/zuora-togai/images/background-documentation-min.png","decoration":null,"color":{"light":"#F8FAFC","dark":"#0D101F"}},"navbar":{"links":[{"label":"Demo app","href":"https://demo.togai.com"},{"label":"Login","href":"https://app.togai.com/login"}],"primary":{"type":"button","label":"Try for free","href":"https://app.togai.com/onboarding"}},"footer":{"socials":{"website":"https://togai.com","twitter":"https://twitter.com/togaiHQ","github":"https://github.com/TogaiHQ/","linkedin":"https://www.linkedin.com/company/togai"}},"integrations":{"ga4":{"measurementId":"G-Q0BLXR7WX5"},"gtm":{"tagId":"GTM-TS4BK7Z"}},"navigation":{"global":{"anchors":[{"anchor":"Postman collection","href":"https://www.postman.com/togai-workspace/workspace/togai-public","icon":"folder-open"},{"anchor":"Open API spec","href":"https://github.com/TogaiHQ/togai-mintlify-docs/blob/main/openapi.yaml","icon":{"name":"brackets-curly","style":"solid"}}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zuora-togai","hasAudioNarration":false,"actualSubdomain":"zuora-togai","customDomains":["docs.togai.com"],"gitSource":{"type":"github","owner":"zuora","repo":"togai-mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e64ff325d2bf1006031a","collectionId":"4133aab6-8f92-457d-b1b7-2c069657b8f2","schemaVersion":"v2"},"feedback":{"edits":true,"issues":true},"entitlements":{},"buildId":"6a21e64ff325d2bf1006031a:success","clientVersion":"0.0.3939","searchFilterCounts":[{"language":"default","tag":"API Reference","count":147},{"language":"default","tag":"APIs","count":144},{"language":"default","tag":"Documentation","count":73},{"language":"default","tag":"Integrations","count":36},{"language":"default","tag":"Accounts","count":27},{"language":"default","tag":"How-To's","count":18},{"language":"default","tag":"Price Plan V2","count":13},{"language":"default","tag":"Manage customers","count":12},{"language":"default","tag":"Alerts","count":9},{"language":"default","tag":"Invoices","count":9}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/filter-search-sort","slug":"/api-reference/filter-search-sort","pageMetadata":{"title":"Filtering, Searching and Sorting","description":null,"href":"/api-reference/filter-search-sort"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`All list APIs accept query parameters which enable users to filter, search and sort the results.`}),`\n`,_jsx(Heading,{level:`2`,id:`filtering`,children:`Filtering`}),`\n`,_jsx(Heading,{level:`2`,id:`searching`,children:`Searching`}),`\n`,_jsx(Heading,{level:`2`,id:`sorting`,children:`Sorting`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Filtering, Searching and Sorting","description":null,"href":"/api-reference/filter-search-sort"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Filtering","slug":"filtering","depth":2,"children":[]},{"title":"Searching","slug":"searching","depth":2,"children":[]},{"title":"Sorting","slug":"sorting","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"zuora-togai","siteName":"Togai documentation","title":"Filtering, Searching and Sorting - Togai documentation","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/filter-search-sort","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T03:50:02.731Z","originalFileLocation":"api-reference/filter-search-sort.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Togai documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Filtering, Searching and Sorting - Togai documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Togai documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.togai.com/api-reference/filter-search-sort\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zuora-togai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Filtering%2C+Searching+and+Sorting\u0026amp;theme=a8e87dc17c743feca2314743\u0026amp;signature=b0d996ac5c8a8a0a27320d2bfcea5b8418c08a973e1feb6856c7403d25deb6bc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Filtering, Searching and Sorting - Togai documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zuora-togai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Filtering%2C+Searching+and+Sorting\u0026amp;theme=a8e87dc17c743feca2314743\u0026amp;signature=b0d996ac5c8a8a0a27320d2bfcea5b8418c08a973e1feb6856c7403d25deb6bc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Togai documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2853C2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.togai.com/api-reference/filter-search-sort\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/filter-search-sort.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Togai documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Togai documentation","nav":{"global":{"anchors":[{"anchor":"Postman collection","href":"https://www.postman.com/togai-workspace/workspace/togai-public","icon":"folder-open"},{"anchor":"Open API spec","href":"https://github.com/TogaiHQ/togai-mintlify-docs/blob/main/openapi.yaml","icon":{"name":"brackets-curly","style":"solid"}}]},"versions":[{"version":"v1","tabs":[{"tab":"Documentation","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/docs/introduction"},{"title":"How Togai works?","href":"/docs/how-togai-works"}]},{"group":"Usage metering","pages":[{"group":"Defining an event","pages":[{"title":"Event Schemas","href":"/docs/event-schemas"},{"title":"Event enrichments","href":"/docs/event-enrichments"}]},{"title":"Event Ingestion","href":"/docs/event-ingestion"},{"title":"Usage Meter","href":"/docs/usage-meter"}]},{"group":"Pricing and rating","pages":[{"title":"Billable Items","href":"/docs/billable-items"},{"group":"Price Plan","pages":[{"title":"Overview","href":"/docs/price-plan-overview"},{"title":"Pricing cycle","href":"/docs/pricing-cycle"},{"title":"Rate cards","href":"/docs/rate-cards"},{"title":"Pricing Rules","href":"/docs/pricing-rules"},{"title":"Lifecycle and version control","href":"/docs/price-plan-lifecycle-version"}]}]},{"group":"Manage customers","pages":[{"title":"Customers","href":"/docs/customers"},{"title":"Price plan overrides","href":"/docs/price-plan-overrides"},{"title":"Price Plan Schedule","href":"/docs/price-plan-schedule"},{"group":"Quote to cash","pages":[{"title":"Quote to cash overview","href":"/docs/qtc-overview"},{"title":"Proposals","href":"/docs/proposals"},{"title":"Purchases","href":"/docs/purchases"}]},{"title":null,"href":"/docs/customer-portal"},{"group":"UI Widgets","pages":[{"title":null,"href":"/docs/ui-widgets/introduction"},{"title":null,"href":"/docs/ui-widgets/usage"},{"title":null,"href":"/docs/ui-widgets/api"},{"title":null,"href":"/docs/ui-widgets/custom-theme-and-styles"},{"title":null,"href":"/docs/ui-widgets/others"}]}]},{"group":"Billing and payments","pages":[{"title":"Invoices overview","href":"/docs/invoices-overview"},{"title":"Invoice groups","href":"/docs/invoice-groups"},{"title":"Invoice templates","href":"/docs/invoice-templates"},{"title":"Credits","href":"/docs/credits"},{"title":"Payments and wallet","href":"/docs/payments-and-wallet"}]},{"group":"Analytics and alerts","pages":[{"title":"Insights overview","href":"/docs/insights-overview"},{"title":"Reports","href":"/docs/reports"},{"title":"Revenue simulator","href":"/docs/revenue-simulator"},{"title":"Alerts","href":"/docs/alerts"}]},{"group":"Configuration","pages":[{"title":"Admin Center","href":"/docs/admin-center"},{"title":"Settings","href":"/docs/settings"},{"title":"Quotas and Limits","href":"/docs/quotas-and-limits"},{"title":"JSON Logic at Togai","href":"/docs/JSON-logic-custom-operators"}]},{"group":"Integrations","pages":[{"title":"Overview","href":"/docs/integrations/overview"},{"title":"Supported Integrations","href":"/docs/integrations/supported-integrations"},{"title":"Webhooks","href":"/docs/integrations/webhooks"},{"group":"Payments","pages":[{"title":"Stripe","href":"/docs/integrations/payments/stripe"},{"title":"Adyen","href":"/docs/integrations/payments/adyen"},{"title":"Paystack","href":"/docs/integrations/payments/paystack"},{"title":"Razorpay","href":"/docs/integrations/payments/razorpay"},{"title":"Verifone","href":"/docs/integrations/payments/verifone"}]},{"group":"Data sources","pages":[{"title":"AWS S3","href":"/docs/integrations/data-sources/aws-s3"},{"title":"AWS Redshift","href":"/docs/integrations/data-sources/aws-redshift"},{"title":"Snowflake","href":"/docs/integrations/data-sources/snowflake"},{"title":"JDBC","href":"/docs/integrations/data-sources/jdbc"},{"title":"Postgres","href":"/docs/integrations/data-sources/postgres"},{"title":"Prometheus","href":"/docs/integrations/data-sources/prometheus"},{"title":"Victoria Metrics","href":"/docs/integrations/data-sources/victoria-metrics"}]},{"group":"Billing \u0026 invoicing","pages":[{"title":"AWS Marketplace","href":"/docs/integrations/billing-and-invoicing/aws-marketplace"},{"title":"Zuora","href":"/docs/integrations/billing-and-invoicing/zuora"},{"title":"Chargebee","href":"/docs/integrations/billing-and-invoicing/chargebee"}]},{"group":"Accounting \u0026 ERP","pages":[{"title":"MS Dynamics 365","href":"/docs/integrations/accounting-and-erp/ms-dynamics"},{"title":"Netsuite","href":"/docs/integrations/accounting-and-erp/netsuite"},{"title":"Quickbooks","href":"/docs/integrations/accounting-and-erp/quickbooks"},{"title":"Sage","href":"/docs/integrations/accounting-and-erp/sage"},{"title":"Xero","href":"/docs/integrations/accounting-and-erp/xero"},{"title":"Odoo","href":"/docs/integrations/accounting-and-erp/odoo"},{"title":"ZohoBooks","href":"/docs/integrations/accounting-and-erp/zohobooks"},{"title":"Payday","href":"/docs/integrations/accounting-and-erp/payday"}]},{"group":"CRM \u0026 CPQ","pages":[{"title":"Salesforce","href":"/docs/integrations/crm-and-cpq/salesforce"},{"title":"Hubspot","href":"/docs/integrations/crm-and-cpq/hubspot"},{"title":"DocuSign","href":"/docs/integrations/crm-and-cpq/docusign"}]},{"group":"Communications","pages":[{"title":"AWS Simple Email Service","href":"/docs/integrations/communications/aws-ses"},{"title":"Slack","href":"/docs/integrations/communications/slack"},{"title":"SMTP","href":"/docs/integrations/communications/smtp"},{"title":"MS Exchange Online","href":"/docs/integrations/communications/ms-exchange-online"}]},{"group":"Marketing","pages":[{"title":"First Promoter","href":"/docs/integrations/marketing/first-promoter"}]},{"group":"Data exports","pages":[{"title":"JDBC","href":"/docs/integrations/data-exports/jdbc-overview"},{"title":"S3","href":"/docs/integrations/data-exports/s3"}]}]}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Getting Started","href":"/api-reference/getting-started"},{"title":"Authentication 🔐","href":"/api-reference/authentication"},{"title":"Pagination 📄","href":"/api-reference/pagination"}]},{"group":"APIs","pages":[{"group":"Authentication","pages":[{"openapi":"post /authenticate","title":"Generate short lived bearer token","href":"/api-reference/authentication/get-bearer-token"},{"title":"Generate portal token","api":"post /organizations/{organization_id}/token","href":"/api-reference/authentication/customer-portal-auth"},{"openapi":"post /portal/token","title":"Get delegate token for customer portal","href":"/api-reference/authentication/get-delegate-token-for-customer-portal"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List customers","href":"/api-reference/customers/list-customers"},{"openapi":"post /customers","title":"Create a customer","href":"/api-reference/customers/create-a-customer"},{"openapi":"get /customers/{customer_id}","title":"Get a customer","href":"/api-reference/customers/get-a-customer"},{"openapi":"delete /customers/{customer_id}","title":"Delete a customer","href":"/api-reference/customers/delete-a-customer"},{"openapi":"patch /customers/{customer_id}","title":"Update a customer","href":"/api-reference/customers/update-a-customer"}]},{"group":"Accounts","pages":[{"openapi":"get /accounts","title":"List accounts of customer","href":"/api-reference/accounts/list-accounts-of-customer"},{"openapi":"post /accounts","title":"Create an account","href":"/api-reference/accounts/create-an-account"},{"openapi":"get /accounts/{account_id}","title":"Get an account","href":"/api-reference/accounts/get-an-account"},{"openapi":"delete /accounts/{account_id}","title":"Delete an account","href":"/api-reference/accounts/delete-an-account"},{"openapi":"patch /accounts/{account_id}","title":"Update an account","href":"/api-reference/accounts/update-an-account"},{"group":"Account Aliases","pages":[{"openapi":"get /accounts/{account_id}/account_aliases","title":"Get all aliases of an account","href":"/api-reference/accounts/account-aliases/get-all-aliases-of-an-account"},{"openapi":"post /accounts/{account_id}/add_aliases","title":"Add Aliases to account","href":"/api-reference/accounts/account-aliases/add-aliases-to-account"},{"openapi":"post /accounts/{account_id}/remove_aliases","title":"Remove Aliases to account","href":"/api-reference/accounts/account-aliases/remove-aliases-to-account"}]},{"group":"(Deprecated) Plan Associations","pages":[{"openapi":"get /accounts/{account_id}/pricing_schedules","title":"(DEPRECATED) List pricing schedules of an account","href":"/api-reference/accounts/plan-association/list-pricing-schedules-of-an-account"},{"openapi":"post /accounts/{account_id}/edit_schedules","title":"(DEPRECATED) Edit schedules of an account.","href":"/api-reference/accounts/plan-association/edit-schedules-of-an-account"},{"openapi":"post /accounts/{account_id}/price_plans","title":"(DEPRECATED) Dissociate or associate a price plan with an account","href":"/api-reference/accounts/plan-association/disassociate-a-plan-fromto-an-account"}]},{"group":"(Deprecated) Purchases","pages":[{"openapi":"get /accounts/{account_id}/purchases","title":"(DEPRECATED) Get all purchases for an account","href":"/api-reference/accounts/purchases/get-all-purchases-for-an-account"},{"openapi":"post /accounts/{account_id}/purchases","title":"(DEPRECATED) Initiate a purchase","href":"/api-reference/accounts/purchases/initiate-a-purchase"},{"openapi":"get /purchases/{purchase_id}","title":"(DEPRECATED) Get a specific purchase of an account","href":"/api-reference/accounts/purchases/get-a-specific-purchase-of-an-account"}]},{"group":"(Deprecated) Proposals","pages":[{"openapi":"get /accounts/{account_id}/purchase_proposals","title":"(DEPRECATED) List all proposals of an account","href":"/api-reference/accounts/proposals/list-all-proposals-of-an-account"},{"openapi":"post /accounts/{account_id}/purchase_proposals","title":"(DEPRECATED) Propose a purchase of a plan","href":"/api-reference/accounts/proposals/propose-a-purchase-of-a-plan"},{"openapi":"get /purchase_proposals/{purchase_proposal_id}","title":"(DEPRECATED) Get proposal information","href":"/api-reference/accounts/proposals/get-proposal-information"},{"openapi":"post /purchase_proposals/{purchase_proposal_id}/update_status","title":"(DEPRECATED) Approve or decline a purchase of a billing plan","href":"/api-reference/accounts/proposals/approve-or-decline-a-purchase-of-a-billing-plan"}]},{"group":"Schedules","pages":[{"openapi":"get /v2/schedules/{schedule_id}/rate_cards","title":"List rate cards","href":"/api-reference/schedules/list-rate-cards"},{"openapi":"post /v2/schedules/{schedule_id}/rate_cards","title":"Bulk rate card operations on a schedule","href":"/api-reference/schedules/bulk-rate-card-operations-on-a-schedule"},{"openapi":"post /v2/accounts/{account_id}/edit_schedules","title":"Bulk edit schedules of an account","href":"/api-reference/schedules/bulk-edit-schedules-of-an-account"},{"openapi":"get /v2/accounts/{account_id}/schedules","title":"List pricing schedules of an account","href":"/api-reference/schedules/list-pricing-schedules-of-an-account"},{"openapi":"get /v2/schedules/{schedule_id}/errors","title":"Get list of errors of a acc schedule","href":"/api-reference/schedules/get-list-of-errors-of-a-acc-schedule"},{"openapi":"delete /v2/accounts/{account_id}/discard_schedules","title":"Discard schedules of an account","href":"/api-reference/schedules/discard-schedules-of-an-account"},{"openapi":"post /v2/accounts/{account_id}/finalize_schedules","title":"Finalize schedules of an account","href":"/api-reference/schedules/finalize-schedules-of-an-account"},{"openapi":"get /v2/schedules/{schedule_id}/pricing_rules","title":"List pricing rules of a account schedule","href":"/api-reference/schedules/list-pricing-rules-of-a-account-schedule"},{"openapi":"put /v2/schedules/{schedule_id}/pricing_rules","title":"Update pricing rules of a account schedule","href":"/api-reference/schedules/update-pricing-rules-of-a-account-schedule"}]}]},{"group":"Aliases","pages":[{"openapi":"get /aliases","title":"List all aliases","href":"/api-reference/aliases/list-all-aliases"},{"openapi":"post /aliases","title":"Create an alias","href":"/api-reference/aliases/create-an-alias"},{"openapi":"get /aliases/{alias}","title":"Get an alias","href":"/api-reference/aliases/get-an-alias"},{"openapi":"delete /aliases/{alias}","title":"Delete an alias","href":"/api-reference/aliases/delete-an-alias"}]},{"group":"Event Schemas","pages":[{"openapi":"get /event_schema","title":"List event schemas","href":"/api-reference/event-schemas/list-event-schemas"},{"openapi":"post /event_schema","title":"Create an event schema","href":"/api-reference/event-schemas/create-an-event-schema"},{"openapi":"get /event_schema/{event_schema_name}","title":"Get an event schema","href":"/api-reference/event-schemas/get-an-event-schema"},{"openapi":"delete /event_schema/{event_schema_name}","title":"Delete an event schema","href":"/api-reference/event-schemas/delete-an-event-schema"},{"openapi":"patch /event_schema/{event_schema_name}","title":"Update an event schema","href":"/api-reference/event-schemas/update-an-event-schema"},{"openapi":"get /event_schema/{event_schema_name}/versions","title":"List all event schema versions","href":"/api-reference/event-schemas/list-all-event-schema-versions"},{"openapi":"post /event_schema/{event_schema_name}/activate","title":"Activate an event schema","href":"/api-reference/event-schemas/activate-an-event-schema"},{"openapi":"post /event_schema/{event_schema_name}/deactivate","title":"Deactivate an event schema","href":"/api-reference/event-schemas/deactivate-an-event-schema"}]},{"group":"Usage Meters","pages":[{"openapi":"get /usage_meters","title":"List usage meters for event schema","href":"/api-reference/usage-meters/list-usage-meters-for-event-schema"},{"openapi":"post /usage_meters","title":"Create an usage meter","href":"/api-reference/usage-meters/create-an-usage-meter"},{"openapi":"get /usage_meters/{usage_meter_id}","title":"Get usage meter","href":"/api-reference/usage-meters/get-usage-meter"},{"openapi":"delete /usage_meters/{usage_meter_id}","title":"Delete an Usage Meter","href":"/api-reference/usage-meters/delete-an-usage-meter"},{"openapi":"patch /usage_meters/{usage_meter_id}","title":"Update an usage meter","href":"/api-reference/usage-meters/update-an-usage-meter"},{"openapi":"post /usage_meters/{usage_meter_id}/activate","title":"Activate usage meter","href":"/api-reference/usage-meters/activate-usage-meter"},{"openapi":"post /usage_meters/{usage_meter_id}/deactivate","title":"Deactivate usage meter","href":"/api-reference/usage-meters/deactivate-usage-meter"}]},{"group":"AddOns","pages":[{"openapi":"get /addons","title":"List addOns","href":"/api-reference/addons/list-addons"},{"openapi":"post /addons","title":"Create an AddOn","href":"/api-reference/addons/create-an-addon"},{"openapi":"get /addons/{addon_id}","title":"Get an addon","href":"/api-reference/addons/get-an-addon"},{"openapi":"delete /addons/{addon_id}","title":"Delete an addon","href":"/api-reference/addons/delete-an-addon"},{"openapi":"patch /addons/{addon_id}","title":"Update an addon","href":"/api-reference/addons/update-an-addon"}]},{"group":"Licenses","pages":[{"openapi":"get /license_updates","title":"Get a list of licenses updates","href":"/api-reference/licenses/get-a-list-of-licenses-updates"},{"openapi":"post /license_updates","title":"Update a license entry","href":"/api-reference/licenses/update-a-license-entry"},{"openapi":"get /named_license_updates","title":"Get a list of named licenses updates","href":"/api-reference/licenses/get-a-list-of-named-licenses-updates"}]},{"group":"Feature","pages":[{"openapi":"get /features","title":"List Feature","href":"/api-reference/feature/list-feature"},{"openapi":"post /features","title":"Create a Feature and optionally associate with one or more event_schemas","href":"/api-reference/feature/create-a-feature-and-optionally-associate-with-one-or-more-event_schemas"},{"openapi":"get /features/{feature_id}","title":"Get a Feature","href":"/api-reference/feature/get-a-feature"},{"openapi":"patch /features/{feature_id}","title":"Update a Feature","href":"/api-reference/feature/update-a-feature"}]},{"group":"(Deprecated) Price Plans","pages":[{"openapi":"get /price_plans","title":"(DEPRECATED) List price plans","href":"/api-reference/price-plans/list-price-plans"},{"openapi":"post /price_plans","title":"(DEPRECATED) Create a price plan","href":"/api-reference/price-plans/create-a-price-plan"},{"openapi":"get /price_plans/{price_plan_id}","title":"(DEPRECATED) Get a price plan","href":"/api-reference/price-plans/get-a-price-plan"},{"openapi":"patch /price_plans/{price_plan_id}","title":"(DEPRECATED) Update a price plan","href":"/api-reference/price-plans/update-a-price-plan"},{"openapi":"post /price_plans/{price_plan_id}/activate","title":"(DEPRECATED) Activate a price plan","href":"/api-reference/price-plans/activate-a-price-plan"},{"openapi":"post /price_plans/migration","title":"(DEPRECATED) Create a price plan migration","href":"/api-reference/price-plans/create-a-price-plan-migration"},{"openapi":"delete /price_plans/{price_plan_id}","title":"(DEPRECATED) Archive a price plan","href":"/api-reference/price-plans/archive-a-price-plan"}]},{"group":"Price Plan V2","pages":[{"openapi":"get /v2/price_plans","title":"List price plans","href":"/api-reference/priceplanv2/list-price-plans"},{"openapi":"post /v2/price_plans","title":"Create a price plan","href":"/api-reference/priceplanv2/create-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}","title":"Get a price plan","href":"/api-reference/priceplanv2/get-a-price-plan"},{"openapi":"patch /v2/price_plans/{price_plan_id}","title":"Update a price plan","href":"/api-reference/priceplanv2/update-a-price-plan"},{"openapi":"delete /v2/price_plans/{price_plan_id}/discard","title":"Discard a price plan","href":"/api-reference/priceplanv2/discard-a-price-plan"},{"openapi":"post /v2/price_plans/{price_plan_id}/finalize","title":"Finalize a price plan","href":"/api-reference/priceplanv2/finalize-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/rate_cards","title":"List rate cards of a price plan","href":"/api-reference/priceplanv2/list-rate-cards-of-a-price-plan"},{"openapi":"post /v2/price_plans/{price_plan_id}/rate_cards","title":"Bulk rate card operations of a price plan","href":"/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/pricing_rules","title":"List pricing rules of a price plan","href":"/api-reference/priceplanv2/list-pricing-rules-of-a-price-plan"},{"openapi":"put /v2/price_plans/{price_plan_id}/pricing_rules","title":"Update pricing rules of a price plan","href":"/api-reference/priceplanv2/update-pricing-rules-of-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/errors","title":"Get list of errors of a price plan","href":"/api-reference/priceplanv2/get-list-of-errors-of-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/versions","title":"List price plan versions","href":"/api-reference/priceplanv2/list-price-plan-versions"},{"openapi":"post /v2/price_plans/migration","title":"Create a price plan v2 migration","href":"/api-reference/priceplanv2/create-a-price-plan-v2-migration"}]},{"group":"Settings","pages":[{"openapi":"get /settings","title":"Lists settings","href":"/api-reference/settings/lists-settings"},{"openapi":"post /settings","title":"Create a setting","href":"/api-reference/settings/create-a-setting"},{"openapi":"get /settings/{setting_id_str}","title":"Get a setting","href":"/api-reference/settings/get-a-setting"},{"openapi":"patch /settings/{setting_id_str}","title":"Update a setting","href":"/api-reference/settings/update-a-setting"}]},{"group":"Price Experimentation","pages":[{"openapi":"post /revenue_calculator","title":"(DEPRECATED) Calculate and return the revenue for a existing or new price plan","href":"/api-reference/price-experimentation/calculate-and-return-the-revenue-for-a-existing-or-new-price-plan"}]},{"group":"Jobs","pages":[{"openapi":"get /jobs/{job_id}","title":"Get the status of a job","href":"/api-reference/jobs/get-the-status-of-a-job"},{"openapi":"get /jobs","title":"List jobs","href":"/api-reference/jobs/list-jobs"},{"openapi":"post /jobs/{job_id}/confirm","title":"Confirm a job","href":"/api-reference/jobs/confirm-a-job"},{"openapi":"post /jobs/{job_id}/reject","title":"Reject a job","href":"/api-reference/jobs/reject-a-job"},{"openapi":"get /jobs/{job_id}/entries","title":"List job entries","href":"/api-reference/jobs/list-job-entries"}]},{"group":"Event Ingestion","pages":[{"openapi":"post /ingest","title":"Ingest events to Togai","href":"/api-reference/event-ingestion/ingest-events-to-togai"},{"openapi":"post /ingestBatch","title":"Ingest events to Togai in batch","href":"/api-reference/event-ingestion/ingest-events-to-togai-in-batch"}]},{"group":"Entitlements","pages":[{"openapi":"post /entitled","title":"Ingest event if a user is entitled to a feature","href":"/api-reference/entitlements/ingest-event-if-a-user-is-entitled-to-a-feature"},{"openapi":"get /accounts/{account_id}/features/{feature_id}","title":"Get Feature credits balance","href":"/api-reference/entitlements/get-feature-credits-balance"},{"openapi":"get /accounts/{account_id}/features/{feature_id}/entries","title":"List feature credits entries of a feature for an account","href":"/api-reference/entitlements/list-feature-credits-entries-of-a-feature-for-an-account"},{"openapi":"patch /accounts/{account_id}/features/{feature_id}/entries/{entry_id}","title":"Update a feature credits entry","href":"/api-reference/entitlements/update-a-feature-credits-entry-of-a-feature-for-an-account"},{"openapi":"post /accounts/{account_id}/features/{feature_id}/entries/{entry_id}/void","title":"Void a feature credits entry of a feature for an account","href":"/api-reference/entitlements/void-a-feature-credits-entry-of-a-feature-for-an-account"},{"openapi":"get /accounts/{account_id}/entitlements","title":"Get entitlements for a account","href":"/api-reference/entitlements/get-entitlements-for-a-account"},{"openapi":"post /accounts/{account_id}/entitlements/{feature_id}","title":"Check entitlement value for a account","href":"/api-reference/entitlements/check-entitlement-value-for-a-account"},{"openapi":"get /accounts/{account_id}/entitlements/{feature_id}","title":"Get entitlement value for a account","href":"/api-reference/entitlements/get-entitlement-value-for-a-account"}]},{"group":"Event Management","pages":[{"openapi":"get /events","title":"Get a list of usage events with multiple query options","href":"/api-reference/event-management/get-a-list-of-usage-events-with-multiple-query-options"},{"openapi":"get /events/{event_id}","title":"Get an event using event id","href":"/api-reference/event-management/get-an-usage-event-using-event-id"},{"openapi":"post /events/correction","title":"Correct an ingested event","href":"/api-reference/event-management/correct-an-ingested-event"}]},{"group":"Metrics","pages":[{"openapi":"post /metrics","title":"Get Togai Metrics","href":"/api-reference/metrics/get-togai-metrics"}]},{"group":"Credits","pages":[{"openapi":"get /credits","title":"List credits","href":"/api-reference/credits/list-credits"},{"openapi":"post /credits","title":"Grant credit","href":"/api-reference/credits/grant-credit"},{"openapi":"get /credits/{credit_id}","title":"Get credit details","href":"/api-reference/credits/get-credit-details"},{"openapi":"post /credits/{credit_id}/void","title":"Void credit","href":"/api-reference/credits/void-credit"},{"openapi":"get /accounts/{account_id}/credit_balance","title":"Credit balance for Account","href":"/api-reference/credits/credit-balance-for-account"}]},{"group":"Invoices","pages":[{"openapi":"get /invoices","title":"List invoices","href":"/api-reference/invoices/list-invoices"},{"openapi":"get /invoices/{invoice_id}","title":"Get an invoice","href":"/api-reference/invoices/get-an-invoice"},{"openapi":"get /invoice/{invoice_id}/pricing_rules_logs","title":"List pricing rule logs","href":"/api-reference/invoices/list-pricing-rule-logs"},{"openapi":"put /invoices/{invoice_id}/miscellaneous_charges","title":"Add or update miscellaneous charges in Invoice","href":"/api-reference/invoices/add-or-update-miscellaneous-charges-in-invoice"},{"openapi":"put /accounts/{account_id}/miscellaneous_charges","title":"Add or update miscellaneous charges in upcoming Invoice for a account","href":"/api-reference/invoices/add-or-update-miscellaneous-charges-in-upcoming-invoice-for-a-account"},{"openapi":"post /invoices","title":"Create a custom invoice for an account","href":"/api-reference/invoices/create-a-custom-invoice-for-an-account"},{"openapi":"delete /invoices/{invoice_id}","title":"Delete a custom invoice in DRAFT state","href":"/api-reference/invoices/delete-a-custom-invoice-in-draft-state"},{"openapi":"get /invoices/bill_runs","title":"List invoices eligible for bill run","href":"/api-reference/invoices/list-invoices-eligible-for-bill-run"},{"openapi":"post /invoices/bill_runs","title":"Create a bill run job request","href":"/api-reference/invoices/create-a-bill-run-job-request"}]},{"group":"Payments","pages":[{"openapi":"get /payments","title":"List all payments","href":"/api-reference/payments/list-all-payments"},{"openapi":"get /payments/{payment_id}","title":"Get a payment","href":"/api-reference/payments/get-a-payment"},{"openapi":"post /payments","title":"create payments","href":"/api-reference/payments/create-payments"}]},{"group":"Wallet","pages":[{"openapi":"get /accounts/{account_id}/wallet","title":"Wallet balance for Account","href":"/api-reference/wallet/wallet-balance-for-account"},{"openapi":"get /accounts/{account_id}/wallet/entries","title":"Wallet entries for Account","href":"/api-reference/wallet/wallet-entries-for-account"}]},{"group":"InvoiceGroups","pages":[{"openapi":"get /invoice_groups","title":"List Invoice Groups","href":"/api-reference/invoicegroups/list-invoice-groups"},{"openapi":"post /invoice_groups","title":"Create an invoice group","href":"/api-reference/invoicegroups/create-an-invoice-group"},{"openapi":"get /invoice_groups/{invoice_group_id}","title":"Get information of an invoice group","href":"/api-reference/invoicegroups/get-information-of-an-invoice-group"},{"openapi":"post /invoice_groups/{invoice_group_id}/add_accounts","title":"Add accounts to an invoice group","href":"/api-reference/invoicegroups/add-accounts-to-an-invoice-group"},{"openapi":"post /invoice_groups/{invoice_group_id}/remove_accounts","title":"Remove accounts from an invoice group. Removing all accounts will also delete the invoice group","href":"/api-reference/invoicegroups/remove-accounts-from-an-invoice-group-removing-all-accounts-will-also-delete-the-invoice-group"}]},{"group":"Alerts","pages":[{"title":"Introduction","href":"/api-reference/alerts/introduction"},{"openapi":"get /alert_templates","title":"List alert templates","href":"/api-reference/alerts/list-alert-templates"},{"openapi":"get /alert_templates/{alert_template_id}","title":"Get an alert template","href":"/api-reference/alerts/get-an-alert-template"},{"openapi":"post /alerts","title":"Create an alert","href":"/api-reference/alerts/create-an-alert"},{"openapi":"get /alerts","title":"List alerts","href":"/api-reference/alerts/list-alerts"},{"openapi":"patch /alerts/{alert_id}","title":"Update an alert","href":"/api-reference/alerts/update-an-alert"},{"openapi":"get /incidents","title":"List incidents","href":"/api-reference/alerts/list-incidents"},{"openapi":"get /incidents/{incident_id}","title":"Get an incident","href":"/api-reference/alerts/get-an-incident"},{"openapi":"put /incidents/{incident_id}/status","title":"Update an incident status","href":"/api-reference/alerts/update-an-incident-status"}]},{"group":"Reports","pages":[{"openapi":"get /reports","title":"List reports","href":"/api-reference/reports/list-reports"}]}]}]},{"tab":"Change log","groups":[{"group":"Change Log","pages":[{"title":"Product Updates","icon":"clipboard","href":"/changelog/change-log"}]}]},{"tab":"How-To's","groups":[{"group":"How-To's","pages":[{"title":"How to use Togai - Showcases","href":"/how-tos/overview"},{"title":"Eleven Labs","href":"/how-tos/eleven-labs"},{"title":"OpusClip","href":"/how-tos/opus-clip"},{"title":"Hypertrack","href":"/how-tos/hypertrack"},{"title":"Loxo","href":"/how-tos/loxo"},{"title":"Typeform","href":"/how-tos/typeform"},{"title":"Heygen","href":"/how-tos/heygen"},{"title":"Anthropic","href":"/how-tos/anthropic"},{"title":"Personal.ai","href":"/how-tos/personal-ai"}]}]}]}]},"title":"Filtering, Searching and Sorting - Togai documentation","buildId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","deploymentId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","dynamics":[],"chunks":[]}
