[{"data":1,"prerenderedAt":344},["ShallowReactive",2],{"page:\u002Fguides\u002Frequests":3},{"id":4,"title":5,"apiPage":6,"body":7,"description":335,"extension":336,"layout":337,"meta":338,"navigation":339,"path":340,"playground":337,"seo":341,"stem":342,"__hash__":343},"docs\u002Fguides\u002Frequests.md","Requests & Responses",false,{"type":8,"value":9,"toc":327},"minimark",[10,14,19,23,34,38,83,87,90,118,165,169,175,229,258,262,272,276,279,316,323],[11,12,5],"h1",{"id":13},"requests-responses",[15,16,18],"h2",{"id":17},"base-url","Base URL",[20,21,22],"p",{},"All endpoints are under:",[24,25,31],"pre",{"className":26,"code":28,"language":29,"meta":30},[27],"language-text","https:\u002F\u002Fapi.youvico.com\u002Fapi\n","text","",[32,33,28],"code",{"__ignoreMap":30},[15,35,37],{"id":36},"headers","Headers",[39,40,41,54],"table",{},[42,43,44],"thead",{},[45,46,47,51],"tr",{},[48,49,50],"th",{},"Header",[48,52,53],{},"Value",[55,56,57,70],"tbody",{},[45,58,59,65],{},[60,61,62],"td",{},[32,63,64],{},"Authorization",[60,66,67],{},[32,68,69],{},"Bearer YOUR_API_KEY",[45,71,72,77],{},[60,73,74],{},[32,75,76],{},"Content-Type",[60,78,79,82],{},[32,80,81],{},"application\u002Fjson",", for requests with a body",[15,84,86],{"id":85},"request-body","Request body",[20,88,89],{},"The API accepts and returns JSON.",[91,92,93,111],"ul",{},[94,95,96,97,102,103,106,107,110],"li",{},"List endpoints with ",[98,99,101],"a",{"href":100},"\u002Fguides\u002Fpagination","pagination"," use the ",[32,104,105],{},"QUERY"," method and take their inputs in the body. Send ",[32,108,109],{},"{}"," when you have none.",[94,112,113,114,117],{},"To point at another resource, send an object with its ",[32,115,116],{},"id",":",[24,119,123],{"className":120,"code":121,"language":122,"meta":30,"style":30},"language-json shiki shiki-themes ayu-light ayu-light ayu-dark","{\n  \"folder\": { \"id\": \"DX1234567890ABCD\" }\n}\n","json",[32,124,125,134,159],{"__ignoreMap":30},[126,127,130],"span",{"class":128,"line":129},"line",1,[126,131,133],{"class":132},"snvv_","{\n",[126,135,137,141,144,147,150,152,156],{"class":128,"line":136},2,[126,138,140],{"class":139},"soLcz","  \"folder\"",[126,142,117],{"class":143},"sgRSP",[126,145,146],{"class":132}," { ",[126,148,149],{"class":139},"\"id\"",[126,151,117],{"class":143},[126,153,155],{"class":154},"sHwJV"," \"DX1234567890ABCD\"",[126,157,158],{"class":132}," }\n",[126,160,162],{"class":128,"line":161},3,[126,163,164],{"class":132},"}\n",[15,166,168],{"id":167},"response-body","Response body",[20,170,171,172,117],{},"A response with a result wraps it in ",[32,173,174],{},"data",[24,176,178],{"className":120,"code":177,"language":122,"meta":30,"style":30},"{\n  \"data\": {\n    \"id\": \"bdbff5de-96d7-468f-9db0-85fe28bd6b62\",\n    \"name\": \"Launch Campaign\"\n  }\n}\n",[32,179,180,184,194,207,218,224],{"__ignoreMap":30},[126,181,182],{"class":128,"line":129},[126,183,133],{"class":132},[126,185,186,189,191],{"class":128,"line":136},[126,187,188],{"class":139},"  \"data\"",[126,190,117],{"class":143},[126,192,193],{"class":132}," {\n",[126,195,196,199,201,204],{"class":128,"line":161},[126,197,198],{"class":139},"    \"id\"",[126,200,117],{"class":143},[126,202,203],{"class":154}," \"bdbff5de-96d7-468f-9db0-85fe28bd6b62\"",[126,205,206],{"class":143},",\n",[126,208,210,213,215],{"class":128,"line":209},4,[126,211,212],{"class":139},"    \"name\"",[126,214,117],{"class":143},[126,216,217],{"class":154}," \"Launch Campaign\"\n",[126,219,221],{"class":128,"line":220},5,[126,222,223],{"class":132},"  }\n",[126,225,227],{"class":128,"line":226},6,[126,228,164],{"class":132},[91,230,231,242,248],{},[94,232,233,234,237,238,241],{},"Paginated lists also return a ",[32,235,236],{},"page"," object. See ",[98,239,240],{"href":100},"Pagination",".",[94,243,244,245,241],{},"Requests that return nothing, such as updates and deletes, respond with ",[32,246,247],{},"204 No Content",[94,249,250,251,237,254,241],{},"Failed requests return an ",[32,252,253],{},"error",[98,255,257],{"href":256},"\u002Fguides\u002Ferrors","Errors",[15,259,261],{"id":260},"timestamps","Timestamps",[20,263,264,265,268,269,241],{},"Timestamps are UTC strings in the ",[32,266,267],{},"YYYY-MM-DD HH:mm:ss[.ffffff]"," format, such as ",[32,270,271],{},"2026-04-10 05:11:44.482913",[15,273,275],{"id":274},"field-types","Field types",[20,277,278],{},"Field lists in the API reference use this notation:",[39,280,281,291],{},[42,282,283],{},[45,284,285,288],{},[48,286,287],{},"Notation",[48,289,290],{},"Meaning",[55,292,293,303],{},[45,294,295,300],{},[60,296,297],{},[32,298,299],{},"string",[60,301,302],{},"Always a value of that type",[45,304,305,310],{},[60,306,307],{},[32,308,309],{},"string?",[60,311,312,313],{},"A value of that type, or ",[32,314,315],{},"null",[20,317,318,319,322],{},"Request fields marked ",[32,320,321],{},"required"," must be sent. Other request fields can be left out.",[324,325,326],"style",{},"html pre.shiki code .snvv_, html code.shiki .snvv_{--shiki-light:#5C6166;--shiki-default:#5C6166;--shiki-dark:#BFBDB6}html pre.shiki code .soLcz, html code.shiki .soLcz{--shiki-light:#55B4D4;--shiki-default:#55B4D4;--shiki-dark:#39BAE6}html pre.shiki code .sgRSP, html code.shiki .sgRSP{--shiki-light:#5C6166B3;--shiki-default:#5C6166B3;--shiki-dark:#BFBDB6B3}html pre.shiki code .sHwJV, html code.shiki .sHwJV{--shiki-light:#86B300;--shiki-default:#86B300;--shiki-dark:#AAD94C}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":30,"searchDepth":209,"depth":209,"links":328},[329,330,331,332,333,334],{"id":17,"depth":136,"text":18},{"id":36,"depth":136,"text":37},{"id":85,"depth":136,"text":86},{"id":167,"depth":136,"text":168},{"id":260,"depth":136,"text":261},{"id":274,"depth":136,"text":275},"The base URL, headers, and JSON request and response formats that every endpoint shares.","md",null,{},true,"\u002Fguides\u002Frequests",{"title":5,"description":335},"guides\u002Frequests","xwcTwtuNrK8RFqGHMyUkLKeWx8KKD4W15uWi_1Nos3I",1792305905625]