[{"data":1,"prerenderedAt":849},["ShallowReactive",2],{"navigation":3,"reference:invitations":45},{"title":4,"links":5},"API reference",[6,9,12,15,18,21,24,27,30,33,36,39,42],{"title":7,"href":8},"Accounts","\u002Freference\u002Faccounts",{"title":10,"href":11},"Connect","\u002Freference\u002Fconnect",{"title":13,"href":14},"Calendars","\u002Freference\u002Fcalendars",{"title":16,"href":17},"Events","\u002Freference\u002Fevents",{"title":19,"href":20},"Availability","\u002Freference\u002Favailability",{"title":22,"href":23},"Meetings","\u002Freference\u002Fmeetings",{"title":25,"href":26},"Invitations","\u002Freference\u002Finvitations",{"title":28,"href":29},"Webhooks","\u002Freference\u002Fwebhooks",{"title":31,"href":32},"Metadata","\u002Freference\u002Fmetadata",{"title":34,"href":35},"Keys","\u002Freference\u002Fkeys",{"title":37,"href":38},"Sandbox","\u002Freference\u002Fsandbox",{"title":40,"href":41},"Usage","\u002Freference\u002Fusage",{"title":43,"href":44},"Logs","\u002Freference\u002Flogs",{"kind":46,"title":47,"name":25,"description":48,"sections":49,"tries":57,"body":101},"generated","Invitations API","Invitations sent for virtual calendars.",[50,54],{"id":51,"title":52,"tag":53},"invitations-list","List invitations","GET",{"id":55,"title":56,"tag":53},"invitations-get","Get an invitation",{"invitations.list":58,"invitations.get":91},{"operationId":59,"method":53,"path":60,"summary":52,"fields":61,"body":90,"unavailable":90},"invitations.list","\u002Fv2\u002Finvitations",[62,70,74,83,87],{"name":63,"in":64,"type":65,"required":66,"raw":67,"sample":68,"options":69},"accountId","query","string",false,"{{account.avery}}","sbx_fda58c5980_1",[],{"name":71,"in":64,"type":65,"required":66,"raw":72,"sample":72,"options":73},"eventId","",[],{"name":75,"in":64,"type":65,"required":66,"raw":72,"sample":72,"options":76},"status",[77,78,79,80,81,82],"queued","sent","captured","held","suppressed","failed",{"name":84,"in":64,"type":85,"required":66,"raw":72,"sample":72,"options":86},"limit","integer",[],{"name":88,"in":64,"type":65,"required":66,"raw":72,"sample":72,"options":89},"cursor",[],null,{"operationId":92,"method":53,"path":93,"summary":56,"fields":94,"body":90,"unavailable":90},"invitations.get","\u002Fv2\u002Finvitations\u002F{invitationId}",[95],{"name":96,"in":97,"type":65,"required":98,"raw":99,"sample":99,"options":100},"invitationId","path",true,"inv_from_the_list",[],{"type":102,"value":103},"minimark",[104,108,114,130,133,138,460,462,466,846],[105,106,25],"h1",{"id":107},"invitations",[109,110,111],"lead",{},[112,113,48],"p",{},[115,116,117],"note",{},[112,118,119,120,124,125,129],{},"The examples use IDs from a sample sandbox. Your sandbox has the same people, calendars and events with its own IDs, which ",[121,122,123],"code",{},"GET \u002Fv2\u002Fsandbox"," returns. When you're signed in to the dashboard, ",[126,127,128],"strong",{},"Try it"," fills in your IDs and sends the request to your sandbox, never to live data.",[131,132],"hr",{},[134,135,136],"section-heading",{"id":51,"label":60,"tag":53},[112,137,52],{},[139,140,141,271],"row",{},[142,143,144,150,153,158,199,203],"column",{},[112,145,146,147,149],{},"Lists the invitations that virtual calendars sent for the app, newest first. The sandbox doesn't send invitations. Each one is listed with the status ",[121,148,79],{}," and the iCalendar text attendees would have received.",[151,152],"try-it",{"operation":59},[154,155,157],"h3",{"id":156},"query-parameters","Query parameters",[159,160,161,164,166,185,190],"properties",{},[162,163],"property",{"name":63,"type":65},[162,165],{"name":71,"type":65},[162,167,168],{"name":75,"type":65},[112,169,170,171,173,174,173,176,173,178,173,180,173,182,184],{},"One of ",[121,172,77],{},", ",[121,175,78],{},[121,177,79],{},[121,179,80],{},[121,181,81],{},[121,183,82],{},".",[162,186,187],{"name":84,"type":85},[112,188,189],{},"The maximum number of results in one page. Defaults to 50. From 1 to 200.",[162,191,192],{"name":88,"type":65},[112,193,194,195,198],{},"The ",[121,196,197],{},"nextCursor"," from the previous page.",[154,200,202],{"id":201},"errors","Errors",[204,205,206,217,226,235,244,253,262],"ul",{},[207,208,209,216],"li",{},[210,211,213],"a",{"href":212},"\u002Ferrors\u002FVALIDATION_INVALID_QUERY",[121,214,215],{},"VALIDATION_INVALID_QUERY"," (400): A query parameter is not valid.",[207,218,219,225],{},[210,220,222],{"href":221},"\u002Ferrors\u002FAUTH_INVALID_KEY",[121,223,224],{},"AUTH_INVALID_KEY"," (401): The API key is missing, unknown or revoked.",[207,227,228,234],{},[210,229,231],{"href":230},"\u002Ferrors\u002FAUTH_EXPIRED_KEY",[121,232,233],{},"AUTH_EXPIRED_KEY"," (401): The API key has expired.",[207,236,237,243],{},[210,238,240],{"href":239},"\u002Ferrors\u002FAUTH_INSUFFICIENT_SCOPE",[121,241,242],{},"AUTH_INSUFFICIENT_SCOPE"," (403): The API key or session does not have permission to make this request.",[207,245,246,252],{},[210,247,249],{"href":248},"\u002Ferrors\u002FRATE_LIMIT_EXCEEDED",[121,250,251],{},"RATE_LIMIT_EXCEEDED"," (429): The request rate exceeds this plan's rate limit.",[207,254,255,261],{},[210,256,258],{"href":257},"\u002Ferrors\u002FRATE_LIMIT_BURST",[121,259,260],{},"RATE_LIMIT_BURST"," (429): Too many requests were sent in a short period.",[207,263,264,270],{},[210,265,267],{"href":266},"\u002Ferrors\u002FINTERNAL_ERROR",[121,268,269],{},"INTERNAL_ERROR"," (500): Something went wrong on our end.",[142,272,274,365],{":sticky":273},"true",[275,276,278,312],"code-group",{"label":60,"title":277,"tag":53},"Request",[279,280,285],"pre",{"className":281,"code":282,"filename":283,"language":284,"meta":72,"style":72},"language-bash shiki css-variables","curl 'https:\u002F\u002Fapi.pyas.io\u002Fv2\u002Finvitations?accountId=sbx_fda58c5980_1' \\\n  -H \"x-api-key: $PYAS_API_KEY\"\n","cURL","bash",[121,286,287,303],{"__ignoreMap":72},[288,289,291,295,299],"span",{"class":290},"line",[288,292,294],{"style":293},"color:var(--shiki-token-function)","curl",[288,296,298],{"style":297},"color:var(--shiki-token-string-expression)"," 'https:\u002F\u002Fapi.pyas.io\u002Fv2\u002Finvitations?accountId=sbx_fda58c5980_1'",[288,300,302],{"style":301},"color:var(--shiki-foreground)"," \\",[288,304,305,309],{"class":290},[288,306,308],{"style":307},"color:var(--shiki-token-string)","  -H",[288,310,311],{"style":297}," \"x-api-key: $PYAS_API_KEY\"",[279,313,318],{"className":314,"code":315,"filename":316,"language":317,"meta":72,"style":72},"language-js shiki css-variables","const result = await pyas.invitations.list({\n  \"accountId\": \"sbx_fda58c5980_1\"\n})\n","Node.js","js",[121,319,320,349,360],{"__ignoreMap":72},[288,321,322,326,330,333,336,339,341,343,346],{"class":290},[288,323,325],{"style":324},"color:var(--shiki-token-keyword)","const",[288,327,329],{"style":328},"color:var(--shiki-token-constant)"," result",[288,331,332],{"style":324}," =",[288,334,335],{"style":324}," await",[288,337,338],{"style":328}," pyas",[288,340,184],{"style":293},[288,342,107],{"style":328},[288,344,345],{"style":293},".list",[288,347,348],{"style":301},"({",[288,350,351,354,357],{"class":290},[288,352,353],{"style":297},"  \"accountId\"",[288,355,356],{"style":324},":",[288,358,359],{"style":297}," \"sbx_fda58c5980_1\"",[288,361,362],{"class":290},[288,363,364],{"style":301},"})",[275,366,369],{"label":367,"title":368},"200 OK","Response",[279,370,374],{"className":371,"code":372,"language":373,"meta":72,"style":72},"language-json shiki css-variables","{\n  \"success\": true,\n  \"data\": [],\n  \"provider\": null,\n  \"traceId\": \"trc_5f2a9c1e7b3d4a6f8e0c2b1d\",\n  \"meta\": {\n    \"nextCursor\": null\n  }\n}\n","json",[121,375,376,381,395,407,419,431,441,450,455],{"__ignoreMap":72},[288,377,378],{"class":290},[288,379,380],{"style":301},"{",[288,382,383,386,389,392],{"class":290},[288,384,385],{"style":324},"  \"success\"",[288,387,356],{"style":388},"color:var(--shiki-token-punctuation)",[288,390,391],{"style":328}," true",[288,393,394],{"style":388},",",[288,396,397,400,402,405],{"class":290},[288,398,399],{"style":324},"  \"data\"",[288,401,356],{"style":388},[288,403,404],{"style":301}," []",[288,406,394],{"style":388},[288,408,409,412,414,417],{"class":290},[288,410,411],{"style":324},"  \"provider\"",[288,413,356],{"style":388},[288,415,416],{"style":328}," null",[288,418,394],{"style":388},[288,420,421,424,426,429],{"class":290},[288,422,423],{"style":324},"  \"traceId\"",[288,425,356],{"style":388},[288,427,428],{"style":297}," \"trc_5f2a9c1e7b3d4a6f8e0c2b1d\"",[288,430,394],{"style":388},[288,432,433,436,438],{"class":290},[288,434,435],{"style":324},"  \"meta\"",[288,437,356],{"style":388},[288,439,440],{"style":301}," {",[288,442,443,446,448],{"class":290},[288,444,445],{"style":324},"    \"nextCursor\"",[288,447,356],{"style":388},[288,449,416],{"style":328},[288,451,452],{"class":290},[288,453,454],{"style":301},"  }",[288,456,457],{"class":290},[288,458,459],{"style":301},"}",[131,461],{},[134,463,464],{"id":55,"label":93,"tag":53},[112,465,56],{},[139,467,468,540],{},[142,469,470,480,482,486,490,493],{},[112,471,472,475,476,479],{},[126,473,474],{},"In the sandbox:"," Use an ID from ",[121,477,478],{},"GET \u002Fv2\u002Finvitations",". An event with attendees on a virtual calendar creates invitations.",[151,481],{"operation":92},[154,483,485],{"id":484},"path-parameters","Path parameters",[159,487,488],{},[162,489],{"name":96,"type":65,":required":273},[154,491,202],{"id":492},"errors-1",[204,494,495,501,507,513,522,528,534],{},[207,496,497,225],{},[210,498,499],{"href":221},[121,500,224],{},[207,502,503,234],{},[210,504,505],{"href":230},[121,506,233],{},[207,508,509,243],{},[210,510,511],{"href":239},[121,512,242],{},[207,514,515,521],{},[210,516,518],{"href":517},"\u002Ferrors\u002FRESOURCE_NOT_FOUND",[121,519,520],{},"RESOURCE_NOT_FOUND"," (404): The calendar or event was not found.",[207,523,524,252],{},[210,525,526],{"href":248},[121,527,251],{},[207,529,530,261],{},[210,531,532],{"href":257},[121,533,260],{},[207,535,536,270],{},[210,537,538],{"href":266},[121,539,269],{},[142,541,542,604],{":sticky":273},[275,543,544,564],{"label":93,"title":277,"tag":53},[279,545,547],{"className":281,"code":546,"filename":283,"language":284,"meta":72,"style":72},"curl 'https:\u002F\u002Fapi.pyas.io\u002Fv2\u002Finvitations\u002Finv_from_the_list' \\\n  -H \"x-api-key: $PYAS_API_KEY\"\n",[121,548,549,558],{"__ignoreMap":72},[288,550,551,553,556],{"class":290},[288,552,294],{"style":293},[288,554,555],{"style":297}," 'https:\u002F\u002Fapi.pyas.io\u002Fv2\u002Finvitations\u002Finv_from_the_list'",[288,557,302],{"style":301},[288,559,560,562],{"class":290},[288,561,308],{"style":307},[288,563,311],{"style":297},[279,565,567],{"className":314,"code":566,"filename":316,"language":317,"meta":72,"style":72},"const result = await pyas.invitations.get({\n  \"invitationId\": \"inv_from_the_list\"\n})\n",[121,568,569,590,600],{"__ignoreMap":72},[288,570,571,573,575,577,579,581,583,585,588],{"class":290},[288,572,325],{"style":324},[288,574,329],{"style":328},[288,576,332],{"style":324},[288,578,335],{"style":324},[288,580,338],{"style":328},[288,582,184],{"style":293},[288,584,107],{"style":328},[288,586,587],{"style":293},".get",[288,589,348],{"style":301},[288,591,592,595,597],{"class":290},[288,593,594],{"style":297},"  \"invitationId\"",[288,596,356],{"style":324},[288,598,599],{"style":297}," \"inv_from_the_list\"",[288,601,602],{"class":290},[288,603,364],{"style":301},[275,605,606],{"label":367,"title":368},[279,607,609],{"className":371,"code":608,"language":373,"meta":72,"style":72},"{\n  \"success\": true,\n  \"data\": {\n    \"id\": \"inv_23871b494bdc3886eaf3bef0\",\n    \"accountId\": \"sbx_fda58c5980_1\",\n    \"calendarId\": \"calfda58c59801p\",\n    \"eventId\": \"evtrsm7egur84pa64mdnoet\",\n    \"method\": \"REQUEST\",\n    \"kind\": \"new\",\n    \"to\": \"sam.patel@example.org\",\n    \"status\": \"captured\",\n    \"reason\": null,\n    \"subject\": \"Invitation: Project kickoff @ Tue, Nov 10, 2026 10:00 AM to 11:00 AM (America\u002FNew_York)\",\n    \"createdAt\": \"2026-11-14T20:00:32.966Z\",\n    \"sentAt\": null,\n    \"bounced\": false,\n    \"complained\": false,\n    \"ics\": \"BEGIN:VCALENDAR\\r\\nVERSION:2.0\\r\\nPRODID:-\u002F\u002FPyas\u002F\u002FVirtual calendar\u002F\u002FEN\\r\\nCALSCALE:GREGORIAN\\r\\nMETHOD:REQUEST\\r\\nBEGIN:VTIMEZONE\\r\\nTZID:America\u002FNew_York\\r\\nBEGIN:STANDARD\\r\\nDTSTART:19700101T000000\\r\\nTZOFFSETFROM:-0500\\r\\nTZOFFSETTO:-0500\\r\\nEND:STANDARD\\r\\nBEGIN:DAYLIGHT\\r\\nDTSTART:20260308T020000\\r\\nTZOFFSETFROM:-0500\\r\\nTZOFFSETTO:-0400\\r\\nEND:DAYLIGHT\\r\\nBEGIN:STANDARD\\r\\nDTSTART:20261101T020000\\r\\nTZOFFSETFROM:-0400\\r\\nTZOFFSETTO:-0500\\r\\nEND:STANDARD\\r\\nBEGIN:DAYLIGHT\\r\\nDTSTART:20270314T020000\\r\\nTZOFFSETFROM:-0500\\r\\nTZOFFSETTO:-0400\\r\\nEND:DAYLIGHT\\r\\nBEGIN:STANDARD\\r\\nDTSTART:20271107T020000\\r\\nTZOFFSETFROM:-0400\\r\\nTZOFFSETTO:-0500\\r\\nEND:STANDARD\\r\\nEND:VTIMEZONE\\r\\nBEGIN:VEVENT\\r\\nUID:evtrsm7egur84pa64mdnoet@cal.pyas.io\\r\\nSEQUENCE:0\\r\\nDTSTAMP:20261108T200032Z\\r\\nDTSTART;TZID=America\u002FNew_York:20261110T100000\\r\\nDTEND;TZID=America\u002FNew_York:20261110T110000\\r\\nSUMMARY:Project kickoff\\r\\nORGANIZER;CN=Avery Brooks:mailto:calfda58c59801p@cal.pyas.io\\r\\nATTENDEE;CN=Sam Patel;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;RSVP=TRUE:\\r\\n mailto:sam.patel@example.org\\r\\nSTATUS:CONFIRMED\\r\\nTRANSP:OPAQUE\\r\\nEND:VEVENT\\r\\nEND:VCALENDAR\\r\\n\"\n  },\n  \"provider\": null,\n  \"traceId\": \"trc_5f2a9c1e7b3d4a6f8e0c2b1d\",\n  \"meta\": {}\n}\n",[121,610,611,615,625,633,645,656,668,680,692,704,716,728,739,751,763,774,786,797,807,813,823,833,842],{"__ignoreMap":72},[288,612,613],{"class":290},[288,614,380],{"style":301},[288,616,617,619,621,623],{"class":290},[288,618,385],{"style":324},[288,620,356],{"style":388},[288,622,391],{"style":328},[288,624,394],{"style":388},[288,626,627,629,631],{"class":290},[288,628,399],{"style":324},[288,630,356],{"style":388},[288,632,440],{"style":301},[288,634,635,638,640,643],{"class":290},[288,636,637],{"style":324},"    \"id\"",[288,639,356],{"style":388},[288,641,642],{"style":297}," \"inv_23871b494bdc3886eaf3bef0\"",[288,644,394],{"style":388},[288,646,647,650,652,654],{"class":290},[288,648,649],{"style":324},"    \"accountId\"",[288,651,356],{"style":388},[288,653,359],{"style":297},[288,655,394],{"style":388},[288,657,658,661,663,666],{"class":290},[288,659,660],{"style":324},"    \"calendarId\"",[288,662,356],{"style":388},[288,664,665],{"style":297}," \"calfda58c59801p\"",[288,667,394],{"style":388},[288,669,670,673,675,678],{"class":290},[288,671,672],{"style":324},"    \"eventId\"",[288,674,356],{"style":388},[288,676,677],{"style":297}," \"evtrsm7egur84pa64mdnoet\"",[288,679,394],{"style":388},[288,681,682,685,687,690],{"class":290},[288,683,684],{"style":324},"    \"method\"",[288,686,356],{"style":388},[288,688,689],{"style":297}," \"REQUEST\"",[288,691,394],{"style":388},[288,693,694,697,699,702],{"class":290},[288,695,696],{"style":324},"    \"kind\"",[288,698,356],{"style":388},[288,700,701],{"style":297}," \"new\"",[288,703,394],{"style":388},[288,705,706,709,711,714],{"class":290},[288,707,708],{"style":324},"    \"to\"",[288,710,356],{"style":388},[288,712,713],{"style":297}," \"sam.patel@example.org\"",[288,715,394],{"style":388},[288,717,718,721,723,726],{"class":290},[288,719,720],{"style":324},"    \"status\"",[288,722,356],{"style":388},[288,724,725],{"style":297}," \"captured\"",[288,727,394],{"style":388},[288,729,730,733,735,737],{"class":290},[288,731,732],{"style":324},"    \"reason\"",[288,734,356],{"style":388},[288,736,416],{"style":328},[288,738,394],{"style":388},[288,740,741,744,746,749],{"class":290},[288,742,743],{"style":324},"    \"subject\"",[288,745,356],{"style":388},[288,747,748],{"style":297}," \"Invitation: Project kickoff @ Tue, Nov 10, 2026 10:00 AM to 11:00 AM (America\u002FNew_York)\"",[288,750,394],{"style":388},[288,752,753,756,758,761],{"class":290},[288,754,755],{"style":324},"    \"createdAt\"",[288,757,356],{"style":388},[288,759,760],{"style":297}," \"2026-11-14T20:00:32.966Z\"",[288,762,394],{"style":388},[288,764,765,768,770,772],{"class":290},[288,766,767],{"style":324},"    \"sentAt\"",[288,769,356],{"style":388},[288,771,416],{"style":328},[288,773,394],{"style":388},[288,775,776,779,781,784],{"class":290},[288,777,778],{"style":324},"    \"bounced\"",[288,780,356],{"style":388},[288,782,783],{"style":328}," false",[288,785,394],{"style":388},[288,787,788,791,793,795],{"class":290},[288,789,790],{"style":324},"    \"complained\"",[288,792,356],{"style":388},[288,794,783],{"style":328},[288,796,394],{"style":388},[288,798,799,802,804],{"class":290},[288,800,801],{"style":324},"    \"ics\"",[288,803,356],{"style":388},[288,805,806],{"style":297}," \"BEGIN:VCALENDAR\\r\\nVERSION:2.0\\r\\nPRODID:-\u002F\u002FPyas\u002F\u002FVirtual calendar\u002F\u002FEN\\r\\nCALSCALE:GREGORIAN\\r\\nMETHOD:REQUEST\\r\\nBEGIN:VTIMEZONE\\r\\nTZID:America\u002FNew_York\\r\\nBEGIN:STANDARD\\r\\nDTSTART:19700101T000000\\r\\nTZOFFSETFROM:-0500\\r\\nTZOFFSETTO:-0500\\r\\nEND:STANDARD\\r\\nBEGIN:DAYLIGHT\\r\\nDTSTART:20260308T020000\\r\\nTZOFFSETFROM:-0500\\r\\nTZOFFSETTO:-0400\\r\\nEND:DAYLIGHT\\r\\nBEGIN:STANDARD\\r\\nDTSTART:20261101T020000\\r\\nTZOFFSETFROM:-0400\\r\\nTZOFFSETTO:-0500\\r\\nEND:STANDARD\\r\\nBEGIN:DAYLIGHT\\r\\nDTSTART:20270314T020000\\r\\nTZOFFSETFROM:-0500\\r\\nTZOFFSETTO:-0400\\r\\nEND:DAYLIGHT\\r\\nBEGIN:STANDARD\\r\\nDTSTART:20271107T020000\\r\\nTZOFFSETFROM:-0400\\r\\nTZOFFSETTO:-0500\\r\\nEND:STANDARD\\r\\nEND:VTIMEZONE\\r\\nBEGIN:VEVENT\\r\\nUID:evtrsm7egur84pa64mdnoet@cal.pyas.io\\r\\nSEQUENCE:0\\r\\nDTSTAMP:20261108T200032Z\\r\\nDTSTART;TZID=America\u002FNew_York:20261110T100000\\r\\nDTEND;TZID=America\u002FNew_York:20261110T110000\\r\\nSUMMARY:Project kickoff\\r\\nORGANIZER;CN=Avery Brooks:mailto:calfda58c59801p@cal.pyas.io\\r\\nATTENDEE;CN=Sam Patel;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;RSVP=TRUE:\\r\\n mailto:sam.patel@example.org\\r\\nSTATUS:CONFIRMED\\r\\nTRANSP:OPAQUE\\r\\nEND:VEVENT\\r\\nEND:VCALENDAR\\r\\n\"",[288,808,809,811],{"class":290},[288,810,454],{"style":301},[288,812,394],{"style":388},[288,814,815,817,819,821],{"class":290},[288,816,411],{"style":324},[288,818,356],{"style":388},[288,820,416],{"style":328},[288,822,394],{"style":388},[288,824,825,827,829,831],{"class":290},[288,826,423],{"style":324},[288,828,356],{"style":388},[288,830,428],{"style":297},[288,832,394],{"style":388},[288,834,835,837,839],{"class":290},[288,836,435],{"style":324},[288,838,356],{"style":388},[288,840,841],{"style":301}," {}",[288,843,844],{"class":290},[288,845,459],{"style":301},[847,848,72],"style",{},1794697268223]