https://docs.curri.com/docs

1<!doctype html>
2<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/welcome" data-has-hydrated="false">
3<head>
4<meta charset="UTF-8">
5<meta name="generator" content="Docusaurus v3.6.1">
6<title data-rh="true">Welcome | API</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.curri.com/docs/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Welcome | API"><meta data-rh="true" name="description" content="Introduction"><meta data-rh="true" property="og:description" content="Introduction"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://docs.curri.com/docs/"><link data-rh="true" rel="alternate" href="https://docs.curri.com/docs/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.curri.com/docs/" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.0f3bcf03.css">

7<script src="/assets/js/runtime~main.60e7e22c.js" defer="defer"></script>

7

8<script src="/assets/js/main.277d3741.js" defer="defer"></script>

8
9</head>
10<body class="navigation-with-keyboard">

11<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script>

11<div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_h94u" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Curri Logo" class="themedComponent_arf8 themedComponent--light_PmxI"><img src="/img/logo.svg" alt="Curri Logo" class="themedComponent_arf8 themedComponent--dark_moNh"></div><b class="navbar__title text--truncate">API</b></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/teamcurri/api-examples" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Github</a><a href="https://www.curri.com" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Visit Curri</a><div class="toggle_Ir14 colorModeToggle_A7ai"><button class="clean-btn toggleButton_EsZN toggleButtonDisabled_nZH6" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_bO7X"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_HKEv"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_E5bK"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_lWrv"><div class="docsWrapper_fHk6"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_zQlR" type="button"></button><div class="docRoot_w_lC"><aside class="theme-doc-sidebar-container docSidebarContainer_Z_CM"><div class="sidebarViewport_f336"><div class="sidebar_dxra"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SBKd"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/">API</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/">Welcome</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/getting-started">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/getting-started/graphql">Using GraphQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/getting-started/tutorial">

11Tutorial</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/getting-started/examples">Examples</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/queries-and-mutations/get-a-quote">Queries &amp; Mutations</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/webhooks-errors-statuses/webhooks">Webhooks, Errors, &amp; Statuses</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_MxXZ"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_dg9F"><div class="docItemContainer_sb15"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_PFQQ" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_HjU2"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">API</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Welcome</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_RIrT theme-doc-toc-mobile tocMobile_nLPu"><button type="button" class="clean-btn tocCollapsibleButton_cz_p">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_bqvL" id="introduction">Introduction<a href="#introduction" class="hash-link" aria-label="Direct link to Introduction" title="Direct link to Introduction">​</a></h2>
12<p>Our API allows customers direct access to request, book, track, edit, and more on our platform.</p>
13<h2 class="anchor anchorWithStickyNavbar_bqvL" id="access">Access<a href="#access" class="hash-link" aria-label="Direct link to Access" title="Direct link to Access">​</a></h2>
14<p>API access is enabled on a case-by-case basis. You can request access and receive your API keys by completing the following:</p>
15<ol>
16<li><a href="https://app.curri.com/signup/create" target="_blank">Sign up</a> to create a Curri account.</li>
17<li>Fill out this <a href="https://forms.gle/WmUTZ6qmQhUtX7ng8" target="_blank">access request form</a>.</li>
18</ol>
19<p>

19Once we receive your request, someone from our team will contact you about next steps.</p>
20<h2 class="anchor anchorWithStickyNavbar_bqvL" id="features">Features<a href="#features" class="hash-link" aria-label="Direct link to Features" title="Direct link to Features">​</a></h2>
21<h3 class="anchor anchorWithStickyNavbar_bqvL" id="actions">Actions<a href="#actions" class="hash-link" aria-label="Direct link to Actions" title="Direct link to Actions">​</a></h3>
22<p>Our API allows you to:</p>
23<ol>
24<li>Requests quotes for new deliveries</li>
25<li>Book new deliveries</li>
26<li>Cancel or modify existing deliveries</li>
27<li>Track the progress of booked deliveries</li>
28</ol>
29<h3 class="anchor anchorWithStickyNavbar_bqvL" id="vehicles">Vehicles<a href="#vehicles" class="hash-link" aria-label="Direct link to Vehicles" title="Direct link to Vehicles">​</a></h3>
30<p>Our API allows you to book with the following vehicle types:</p>
31<ul>
32<li>Cars</li>
33<li>Pickup Trucks</li>
34<li>SUVs</li>
35<li>Minivans</li>
36<li>Cargo Vans</li>
37<li>High-roofed (Sprinter) Vans</li>
38<li>Box Trucks</li>
39<li>Flatbeds</li>
40<li>Gooseneck Trailers</li>
41<li>Dry Vans</li>
42</ul>
43<p>Other vehicle types such as stakebeds and vehicles with hitches are available on our <a href="https://app.curri.com/book" target="_blank">website</a>. We do not currently offer these vehicle types via our API at this time.</p>
44<h2 class="anchor anchorWithStickyNavbar_bqvL" id="api-sandbox">API Sandbox<a href="#api-sandbox" class="hash-link" aria-label="Direct link to API Sandbox" title="Direct link to API Sandbox">​</a></h2>
45<p>Along with your API key, you will also receive a Sandbox key which will allow you to run through test deliveries.</p>
46<p>No actual drivers will be assigned and no charges will be processed. None of the standard notifications will be sent (SMS, email).</p>
47<p>Just replace your API key with the Sandbox key in the authentication step above.</p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/docs/getting-started"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_Spbm thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#introduction" class="table-of-contents__link toc-highlight">Introduction</a></li><li><a href="#access" class="table-of-contents__link toc-highlight">Access</a></li><li><a href="#features" class="table-of-contents__link toc-highlight">Features</a><ul><li><a href="#actions" class="table-of-contents__link toc-highlight">Actions</a></li><li><a href="#vehicles" class="table-of-contents__link toc-highlight">Vehicles</a></li></ul></li><li><a href="#api-sandbox" class="table-of-contents__link toc-highlight">API Sandbox</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs &amp; Examples</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Getting Started</a></li><li class="footer__item"><a href="https://github.com/teamcurri/api-examples" target="_blank" rel="noopener noreferrer" class="footer__link-item">API Examples</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://twitter.com/curri" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_KtFG"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/teamcurri/api-examples" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_KtFG">

47<path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/terms">API Terms of Use</a></li></ul></div></div></div></footer></div>

48<script type="module" src="https://static.cloudflareinsights.com/beacon.min.js/v31edd6df95cf4e85bb4c19e7a9bdbcba1788362987495" integrity="sha512-iIg7k2xntmwu6/uSb5tpc/hySgZc4eoL31yB29W6tJFo2akwjPWcEqnCEdJvGexCL0KEQwVYv5BlowfhVz26hg==" data-cf-beacon='{"version":"2024.11.0","token":"1d3a6cba80f7462a86663e0199abeb84","spa":2}' crossorigin="anonymous"></script>

48
49</body>
50</html>