[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fapi\u002Fendpoints":3},{"_path":4,"title":5,"description":6,"navigation":7,"image":13,"head":18,"body":32},"\u002Fdocs\u002Fapi\u002Fendpoints","API Endpoints · Waitlister Documentation","Explore all available endpoints in the Waitlister API for managing your waitlist programmatically.",{"title":8,"parent":9,"group":10,"description":11,"order":12},"Endpoints","API Reference","Advanced","Overview of all available API endpoints.",4,{"src":14,"width":15,"height":16,"alt":17},"https:\u002F\u002Ffirebasestorage.googleapis.com\u002Fv0\u002Fb\u002Fwaitinglist-app-c24fc.appspot.com\u002Fo\u002Fdocs-og-image.png?alt=media&token=85e60b24-c882-4f84-aa9e-ef85e1ae4bb5",400,300,"Waitlister API Endpoints",{"meta":19},[20,23,26,29],{"name":21,"content":22},"keywords","api endpoints, waitlist api, rest api, waitlist integration, subscriber management",{"name":24,"content":25},"robots","index, follow",{"name":27,"content":28},"author","Waitlister",{"name":30,"content":31},"copyright","© 2026 Waitlister",{"type":33,"children":34,"toc":571},"root",[35,48,55,60,67,72,79,84,227,233,238,292,298,303,309,326,332,337,347,353,358,364,375,403,409,418,424,429],{"type":36,"tag":37,"props":38,"children":39},"element","p",{},[40],{"type":36,"tag":41,"props":42,"children":45},"span",{"className":43},[44],"secondary-heading",[46],{"type":47,"value":9},"text",{"type":36,"tag":49,"props":50,"children":52},"h1",{"id":51},"api-endpoints",[53],{"type":47,"value":54},"API Endpoints",{"type":36,"tag":37,"props":56,"children":57},{},[58],{"type":47,"value":59},"The Waitlister API provides several endpoints for managing your waitlist programmatically. This page gives an overview of all available endpoints organized by category.",{"type":36,"tag":61,"props":62,"children":64},"h2",{"id":63},"endpoint-categories",[65],{"type":47,"value":66},"Endpoint Categories",{"type":36,"tag":37,"props":68,"children":69},{},[70],{"type":47,"value":71},"Waitlister API endpoints are organized into categories based on their functionality.",{"type":36,"tag":73,"props":74,"children":76},"h3",{"id":75},"subscribers-endpoints",[77],{"type":47,"value":78},"Subscribers Endpoints",{"type":36,"tag":37,"props":80,"children":81},{},[82],{"type":47,"value":83},"These endpoints allow you to manage your waitlist subscribers.",{"type":36,"tag":85,"props":86,"children":87},"table",{},[88,117],{"type":36,"tag":89,"props":90,"children":91},"thead",{},[92],{"type":36,"tag":93,"props":94,"children":95},"tr",{},[96,102,107,112],{"type":36,"tag":97,"props":98,"children":99},"th",{},[100],{"type":47,"value":101},"Endpoint",{"type":36,"tag":97,"props":103,"children":104},{},[105],{"type":47,"value":106},"Method",{"type":36,"tag":97,"props":108,"children":109},{},[110],{"type":47,"value":111},"Description",{"type":36,"tag":97,"props":113,"children":114},{},[115],{"type":47,"value":116},"Rate Limit Category",{"type":36,"tag":118,"props":119,"children":120},"tbody",{},[121,150,176,201],{"type":36,"tag":93,"props":122,"children":123},{},[124,135,140,145],{"type":36,"tag":125,"props":126,"children":127},"td",{},[128],{"type":36,"tag":129,"props":130,"children":132},"a",{"href":131},"\u002Fdocs\u002Fapi\u002Fendpoints\u002Fsubscribers\u002Fadd-subscriber",[133],{"type":47,"value":134},"Add Subscriber",{"type":36,"tag":125,"props":136,"children":137},{},[138],{"type":47,"value":139},"POST",{"type":36,"tag":125,"props":141,"children":142},{},[143],{"type":47,"value":144},"Add a new subscriber to your waitlist",{"type":36,"tag":125,"props":146,"children":147},{},[148],{"type":47,"value":149},"Subscriber Endpoints",{"type":36,"tag":93,"props":151,"children":152},{},[153,162,167,172],{"type":36,"tag":125,"props":154,"children":155},{},[156],{"type":36,"tag":129,"props":157,"children":159},{"href":158},"\u002Fdocs\u002Fapi\u002Fendpoints\u002Fsubscribers\u002Flist-subscribers",[160],{"type":47,"value":161},"List Subscribers",{"type":36,"tag":125,"props":163,"children":164},{},[165],{"type":47,"value":166},"GET",{"type":36,"tag":125,"props":168,"children":169},{},[170],{"type":47,"value":171},"Retrieve a paginated list of subscribers",{"type":36,"tag":125,"props":173,"children":174},{},[175],{"type":47,"value":149},{"type":36,"tag":93,"props":177,"children":178},{},[179,188,192,197],{"type":36,"tag":125,"props":180,"children":181},{},[182],{"type":36,"tag":129,"props":183,"children":185},{"href":184},"\u002Fdocs\u002Fapi\u002Fendpoints\u002Fsubscribers\u002Fget-subscriber",[186],{"type":47,"value":187},"Get Subscriber",{"type":36,"tag":125,"props":189,"children":190},{},[191],{"type":47,"value":166},{"type":36,"tag":125,"props":193,"children":194},{},[195],{"type":47,"value":196},"Retrieve information about a specific subscriber by ID or email",{"type":36,"tag":125,"props":198,"children":199},{},[200],{"type":47,"value":149},{"type":36,"tag":93,"props":202,"children":203},{},[204,213,218,223],{"type":36,"tag":125,"props":205,"children":206},{},[207],{"type":36,"tag":129,"props":208,"children":210},{"href":209},"\u002Fdocs\u002Fapi\u002Fendpoints\u002Fsubscribers\u002Fupdate-subscriber",[211],{"type":47,"value":212},"Update Subscriber",{"type":36,"tag":125,"props":214,"children":215},{},[216],{"type":47,"value":217},"PUT",{"type":36,"tag":125,"props":219,"children":220},{},[221],{"type":47,"value":222},"Update a subscriber's information",{"type":36,"tag":125,"props":224,"children":225},{},[226],{"type":47,"value":149},{"type":36,"tag":73,"props":228,"children":230},{"id":229},"analytics-endpoints",[231],{"type":47,"value":232},"Analytics Endpoints",{"type":36,"tag":37,"props":234,"children":235},{},[236],{"type":47,"value":237},"These endpoints help you track key metrics for your waitlist.",{"type":36,"tag":85,"props":239,"children":240},{},[241,263],{"type":36,"tag":89,"props":242,"children":243},{},[244],{"type":36,"tag":93,"props":245,"children":246},{},[247,251,255,259],{"type":36,"tag":97,"props":248,"children":249},{},[250],{"type":47,"value":101},{"type":36,"tag":97,"props":252,"children":253},{},[254],{"type":47,"value":106},{"type":36,"tag":97,"props":256,"children":257},{},[258],{"type":47,"value":111},{"type":36,"tag":97,"props":260,"children":261},{},[262],{"type":47,"value":116},{"type":36,"tag":118,"props":264,"children":265},{},[266],{"type":36,"tag":93,"props":267,"children":268},{},[269,278,282,287],{"type":36,"tag":125,"props":270,"children":271},{},[272],{"type":36,"tag":129,"props":273,"children":275},{"href":274},"\u002Fdocs\u002Fapi\u002Fendpoints\u002Fanalytics\u002Flog-view",[276],{"type":47,"value":277},"Log View",{"type":36,"tag":125,"props":279,"children":280},{},[281],{"type":47,"value":139},{"type":36,"tag":125,"props":283,"children":284},{},[285],{"type":47,"value":286},"Record a view of your waitlist",{"type":36,"tag":125,"props":288,"children":289},{},[290],{"type":47,"value":291},"Log View Endpoint",{"type":36,"tag":61,"props":293,"children":295},{"id":294},"common-parameters",[296],{"type":47,"value":297},"Common Parameters",{"type":36,"tag":37,"props":299,"children":300},{},[301],{"type":47,"value":302},"All endpoints share some common parameters.",{"type":36,"tag":73,"props":304,"children":306},{"id":305},"path-parameters",[307],{"type":47,"value":308},"Path Parameters",{"type":36,"tag":310,"props":311,"children":312},"ul",{},[313],{"type":36,"tag":314,"props":315,"children":316},"li",{},[317,324],{"type":36,"tag":318,"props":319,"children":321},"code",{"className":320},[],[322],{"type":47,"value":323},"{waitlist-key}",{"type":47,"value":325}," - Your unique waitlist key, found in your waitlist settings",{"type":36,"tag":73,"props":327,"children":329},{"id":328},"headers",[330],{"type":47,"value":331},"Headers",{"type":36,"tag":37,"props":333,"children":334},{},[335],{"type":47,"value":336},"All API requests require these headers:",{"type":36,"tag":338,"props":339,"children":341},"pre",{"code":340},"Content-Type: application\u002Fjson\nX-Api-Key: your-api-key\n",[342],{"type":36,"tag":318,"props":343,"children":345},{"__ignoreMap":344},"",[346],{"type":47,"value":340},{"type":36,"tag":61,"props":348,"children":350},{"id":349},"response-format",[351],{"type":47,"value":352},"Response Format",{"type":36,"tag":37,"props":354,"children":355},{},[356],{"type":47,"value":357},"All API endpoints return responses in JSON format with a consistent structure.",{"type":36,"tag":73,"props":359,"children":361},{"id":360},"success-response",[362],{"type":47,"value":363},"Success Response",{"type":36,"tag":338,"props":365,"children":370},{"code":366,"language":367,"meta":344,"className":368},"{\n  \"success\": true,\n  \"message\": \"Operation successful\"\n}\n","json",[369],"language-json",[371],{"type":36,"tag":318,"props":372,"children":373},{"__ignoreMap":344},[374],{"type":47,"value":366},{"type":36,"tag":37,"props":376,"children":377},{},[378,380,386,388,394,395,401],{"type":47,"value":379},"Additional fields are included depending on the endpoint (e.g. ",{"type":36,"tag":318,"props":381,"children":383},{"className":382},[],[384],{"type":47,"value":385},"data",{"type":47,"value":387},", ",{"type":36,"tag":318,"props":389,"children":391},{"className":390},[],[392],{"type":47,"value":393},"position",{"type":47,"value":387},{"type":36,"tag":318,"props":396,"children":398},{"className":397},[],[399],{"type":47,"value":400},"referral_code",{"type":47,"value":402},").",{"type":36,"tag":73,"props":404,"children":406},{"id":405},"error-response",[407],{"type":47,"value":408},"Error Response",{"type":36,"tag":338,"props":410,"children":413},{"code":411,"language":367,"meta":344,"className":412},"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"error_code\",\n    \"message\": \"Human-readable error message\"\n  }\n}\n",[369],[414],{"type":36,"tag":318,"props":415,"children":416},{"__ignoreMap":344},[417],{"type":47,"value":411},{"type":36,"tag":61,"props":419,"children":421},{"id":420},"response-codes",[422],{"type":47,"value":423},"Response Codes",{"type":36,"tag":37,"props":425,"children":426},{},[427],{"type":47,"value":428},"The API uses standard HTTP response codes.",{"type":36,"tag":85,"props":430,"children":431},{},[432,447],{"type":36,"tag":89,"props":433,"children":434},{},[435],{"type":36,"tag":93,"props":436,"children":437},{},[438,443],{"type":36,"tag":97,"props":439,"children":440},{},[441],{"type":47,"value":442},"Code",{"type":36,"tag":97,"props":444,"children":445},{},[446],{"type":47,"value":111},{"type":36,"tag":118,"props":448,"children":449},{},[450,468,486,503,520,537,554],{"type":36,"tag":93,"props":451,"children":452},{},[453,463],{"type":36,"tag":125,"props":454,"children":455},{},[456],{"type":36,"tag":318,"props":457,"children":460},{"className":458},[459],"inline-code-green",[461],{"type":47,"value":462},"200",{"type":36,"tag":125,"props":464,"children":465},{},[466],{"type":47,"value":467},"Success",{"type":36,"tag":93,"props":469,"children":470},{},[471,481],{"type":36,"tag":125,"props":472,"children":473},{},[474],{"type":36,"tag":318,"props":475,"children":478},{"className":476},[477],"inline-code-red",[479],{"type":47,"value":480},"400",{"type":36,"tag":125,"props":482,"children":483},{},[484],{"type":47,"value":485},"Bad request (invalid parameters)",{"type":36,"tag":93,"props":487,"children":488},{},[489,498],{"type":36,"tag":125,"props":490,"children":491},{},[492],{"type":36,"tag":318,"props":493,"children":495},{"className":494},[477],[496],{"type":47,"value":497},"401",{"type":36,"tag":125,"props":499,"children":500},{},[501],{"type":47,"value":502},"Authentication error (invalid API key)",{"type":36,"tag":93,"props":504,"children":505},{},[506,515],{"type":36,"tag":125,"props":507,"children":508},{},[509],{"type":36,"tag":318,"props":510,"children":512},{"className":511},[477],[513],{"type":47,"value":514},"403",{"type":36,"tag":125,"props":516,"children":517},{},[518],{"type":47,"value":519},"Permission error (insufficient plan level)",{"type":36,"tag":93,"props":521,"children":522},{},[523,532],{"type":36,"tag":125,"props":524,"children":525},{},[526],{"type":36,"tag":318,"props":527,"children":529},{"className":528},[477],[530],{"type":47,"value":531},"404",{"type":36,"tag":125,"props":533,"children":534},{},[535],{"type":47,"value":536},"Resource not found",{"type":36,"tag":93,"props":538,"children":539},{},[540,549],{"type":36,"tag":125,"props":541,"children":542},{},[543],{"type":36,"tag":318,"props":544,"children":546},{"className":545},[477],[547],{"type":47,"value":548},"429",{"type":36,"tag":125,"props":550,"children":551},{},[552],{"type":47,"value":553},"Rate limit exceeded",{"type":36,"tag":93,"props":555,"children":556},{},[557,566],{"type":36,"tag":125,"props":558,"children":559},{},[560],{"type":36,"tag":318,"props":561,"children":563},{"className":562},[477],[564],{"type":47,"value":565},"500",{"type":36,"tag":125,"props":567,"children":568},{},[569],{"type":47,"value":570},"Server error",{"title":344,"searchDepth":572,"depth":572,"links":573},3,[574,579,583,587],{"id":63,"depth":575,"text":66,"children":576},2,[577,578],{"id":75,"depth":572,"text":78},{"id":229,"depth":572,"text":232},{"id":294,"depth":575,"text":297,"children":580},[581,582],{"id":305,"depth":572,"text":308},{"id":328,"depth":572,"text":331},{"id":349,"depth":575,"text":352,"children":584},[585,586],{"id":360,"depth":572,"text":363},{"id":405,"depth":572,"text":408},{"id":420,"depth":575,"text":423}]