Welcome to PheedLoop's API Documentation!
\nWe'd love to hear your feedback on what's available so far and any additions you'd like to see. Don't hesitate to reach out to our team directly or to hello@pheedloop.com.
\nIn order to authenticate with our API, you require three things:
\nAPI KeyYUou
\nAPI Secret
\nOrganization Code
\nYou can find all this information from your Integrations tab in the Dashboard. You can find all this information here. If that link does not work for you, you can manually navigate to the page by logging into your Dashboard, then going to Settings -> Integrations -> Rest API.
\nThe API Key and API Secret are used in the header of every request and should look like this:
\nThe Organization Code is used in the URL of requests. For example:https://api.pheedloop.com/api/v3/organization/ORGANIZATION-CODE/validateauth/
All URLs should end in a /.
For documentation purposes, we tag each release of our API with a new version number which signifies any changes. These versions can be used to compare the publicly available version of the API to this documentation. We follow a major-minor-patch system:
\nWe do not offer different active versions of the API, but the current version can be retrieved from all response headers, via the PheedLoop-API-Version field. It usually will match the latest release tag documented, but during roll outs the Documentation may be slightly ahead. Use this field to validate which version you are referencing.
Simply returns your organization code, name, and a validated status if successful.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","validateauth",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"5677e6fe-af3c-48b0-9be6-6ebd2b84eeb6","name":"Validate Authentication","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/validateauth/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Aug 2021 14:57:36 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"organization_name\": \"PheedLoop Organization\",\n \"response\": \"validated\",\n \"organization_code\": \"ORGQ5A4PGNJX5YUL59\"\n}"}],"_postman_id":"b450bf4e-d454-4e6b-9a9f-982661aba7b2"}],"id":"cba26497-ce4c-4a4f-8f13-7303caff67f6","description":"You can use this endpoint to validate your authentication with our API. Please follow the steps above and send a GET to this endpoint to ensure your API Key and Secret are active.
Note: This step is optional and not required to use the API but it is useful when troubleshooting authentication issues. You may also use this endpoint to create a test request before making your real request. If this endpoint fails, no other endpoint will be accepted.
\n","event":[{"listen":"prerequest","script":{"id":"d355cd7a-1789-47e2-9870-bbc8b5aaa905","type":"text/javascript","exec":["pm.collectionVariables.set(\"validateFields\","," ["," 'organization_name',"," 'response',"," 'organization_code'"," ]",");"]}},{"listen":"test","script":{"id":"a181a91f-d267-44cb-b371-7d792fcc60d4","type":"text/javascript","exec":[""]}}],"_postman_id":"cba26497-ce4c-4a4f-8f13-7303caff67f6"},{"name":"Event Public APIs","item":[{"name":"Attendees","item":[{"name":"Create Attendee","event":[{"listen":"test","script":{"id":"ddc56547-3433-4d01-aece-a335ce87d0b6","exec":["if (pm.response.code == 303) {"," pm.test(\"Status code is 303\", function () {"," pm.response.to.have.status(303);"," });",""," pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields303\"));"," });",""," pm.collectionVariables.set(\"attendeeCode\", pm.response.json().additionalInformation);"," return","};","","pm.test(\"Status code is either 200 or 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201])","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});","","pm.collectionVariables.set(\"attendeeCode\", pm.response.json().code);","pm.collectionVariables.set(\"attendeeEventCheckInOutCode\", pm.response.json().code);",""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"96b82d80-0d1c-4df1-9d20-fc508b9c36f0","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a5aa8403-9ce8-4135-9214-88890f6080be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{ \"email\": \"jeffbezos@amazon.com\",\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"about\": \"CEO and space traveller.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"206-266-1000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"send_app_welcome_email\": false,\n \"send_attendee_portal_welcome\": false,\n \"send_welcome_virtual_portal_email\": false,\n \"metadata\": {},\n \"profile_visible\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/","description":"Creates a new Attendee and assigns them to your chosen event. If the Attendee is already attending another event in your organization, they are assigned to this event and their information is updated.
\nWhen an Attendee is updated, a 200 status is returned instead of a 201 status.
\nAn additional set of options are available for POSTing Attendees, which is to include a send_welcome_email of true and/or send_welcome_virtual_portal_email of true with the payload. These fields will not be returned in the response as it's not saved with the Attendee. When true, PheedLoop will email the created attendee upon creation, welcoming them to their event, along with their temporary password to log in. If you send the virtual portal email, they will receive an email with a link to the virtual portal, whereas the regular email will include a link to the event landing page.
Creates several new Attendees and assigns them to your chosen event. If the Attendee is already attending another event in your organization, they are assigned to this event and their information is updated.
\nAccepts a list of Attendee objects, using the same structure as defined in the single create endpoint.
\nIf an existing Attendee is found, it is updated instead of created, and a 200 status is returned instead of a 201 status. If you send over duplicate Attendee (same code on several items), you will only receive a single entry for each actual Attendee in the response.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendeesbulk",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"b7cf7c53-ddfd-4f71-93fb-7f4382db9202","name":"Bulk Create Attendee","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=DEF123\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"send_app_welcome_email\": true,\n \"send_attendee_portal_welcome\": true,\n \"send_welcome_virtual_portal_email\": true,\n \"metadata\": {}\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"send_app_welcome_email\": true,\n \"send_attendee_portal_welcome\": true,\n \"send_welcome_virtual_portal_email\": true,\n \"metadata\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/"},"status":"CREATED","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Aug 2021 12:56:39 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"code\": \"ATT3HBIVHA6TC7UBMM7W80L82KM1\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=DEF123\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"linkedin\": \"\",\n \"is_checked_in\": false,\n \"checkin_date\": null\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"code\": \"ATT52RJ426BNUE610TN67PT6U9Y3\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"linkedin\": \"\",\n \"is_checked_in\": false,\n \"checkin_date\": null\n }\n]"}],"_postman_id":"a2a03ce5-da2f-4a82-a334-3b8a440d62dc"},{"name":"List Attendees","event":[{"listen":"test","script":{"id":"c0d99cce-439b-49f5-a35d-cdf72b54a2d1","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json().results[0]).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});","","pm.test(\"Populate attendance list\", function() {"," const res = pm.response.json().results;"," let codesString = []"," for (let i = 0; i < 1; i++) {"," codesString.push(`${res[i].code}`);"," }"," pm.collectionVariables.set(\"attendanceList\", codesString)","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1143cd7f-fd0d-499f-8c35-7b782cda2151","exec":[""],"type":"text/javascript"}}],"id":"81b12a23-c4a9-499a-9943-c751359d14a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/","description":"Lists all Attendees and their information for your chosen event as determined by the Event Code.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nfirst_name
\nlast_name
\norganization
\nis_checked_in
\nSearches will preform a regex sub string look up, so for example, you may filter the data by anyone with a @pheedloop.com email by passing the query ?email=@pheedloop.com.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendees",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"5e2e6256-d92f-4d88-8f99-f795e2f5fc55","name":"List Attendees","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/?page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendees",""],"query":[{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Nov 2021 21:08:15 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"The CEO of Niantic.\",\n \"code\": \"ATTN6EM521N4OJ04MDK7DLPD6HI0\",\n \"code_badge\": \"ATTHV52WKFZGEMB22L9XYO4CBEXN\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"code_internal\": \"12345\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Gluten\",\n \"accessibility_requirements\": \"None\",\n \"designations\": \"Him/His\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n }\n ]\n}"},{"id":"b197339d-cd16-46a1-8bd3-d4ce325d7d43","name":"Search Attendees","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/?first_name=John&last_name=Hanke&is_checked_in=true","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendees",""],"query":[{"key":"first_name","value":"John"},{"key":"last_name","value":"Hanke"},{"key":"is_checked_in","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 17:42:54 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"The CEO of Niantic.\",\n \"code\": \"ATTN6EM521N4OJ04MDK7DLPD6HI0\",\n \"code_badge\": \"ATTHV52WKFZGEMB22L9XYO4CBEXN\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"code_internal\": \"12345\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Gluten\",\n \"accessibility_requirements\": \"None\",\n \"designations\": \"Him/His\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n }\n ]\n}"}],"_postman_id":"81b12a23-c4a9-499a-9943-c751359d14a3"},{"name":"Get Single Attendee","event":[{"listen":"test","script":{"id":"e4448935-46ad-4cf6-ae3d-ff1e5b712559","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6c762668-298f-45e7-944d-7fd04817e18d","exec":[""],"type":"text/javascript"}}],"id":"f9a0248d-f325-4c85-bbbd-d1341582880f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/ATTENDEE-CODE/","description":"Gets a single Attendee, based on the Attendee Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendees","ATTENDEE-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"1eb0509d-7787-483d-8faa-b9f2190ed4cf","name":"Get Single Attendee","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/ATTENDEE-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 16:03:17 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"marty@pheedloop.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"The CEO of Niantic.\",\n \"code\": \"ATTENDEE-CODE\",\n \"code_badge\": \"ATTHV52WKFZGEMB22L9XYO4CBEXN\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"code_internal\": \"12345\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Gluten\",\n \"accessibility_requirements\": \"None\",\n \"designations\": \"Him/His\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\",\n \"profile_visible\": true\n}"}],"_postman_id":"f9a0248d-f325-4c85-bbbd-d1341582880f"},{"name":"Update Attendee","event":[{"listen":"test","script":{"id":"f94b5b3c-928b-49bb-ba46-6c53b0ee5879","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"dbbb7a62-eeed-44fb-9362-d1fb4a29d5b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"206-266-1000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"No longer vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/ATTENDEE-CODE/","description":"Updates the chosen Attendee, but only if they are attending the chosen event. This will update their information across all events they are attending.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendees","ATTENDEE-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"56c719b2-23b0-41da-b290-c44b8daa91e5","name":"Update Attendee","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"206-266-1000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"No longer vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"metadata\": {},\n \"profile_visible\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/ATTENDEE-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Aug 2021 15:53:59 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"code\": \"ATTENDEE-CODE\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"206-266-1000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"No longer vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\",\n \"profile_visible\": true\n}"}],"_postman_id":"dbbb7a62-eeed-44fb-9362-d1fb4a29d5b4"},{"name":"Bulk Update Attendee","event":[{"listen":"test","script":{"id":"7f4b4730-9b01-40e0-b3e4-b44306cb921c","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[0]).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});",""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"c6594c59-dfaa-4bba-94b2-c4aa34dc62c0","exec":["postman.setNextRequest(\"List Events\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9cc2538d-d7e0-43b0-b702-ae56fe6c8cc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=GHI123\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ],\n \"metadata\": {}\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ],\n \"metadata\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/","description":"Updates several Attendees, based on either their code or email. This will update their information across all events they are attending.
\nAccepts a list of Attendee objects, using the same structure as defined in the single update endpoint.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendeesbulk",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"33c25e65-58f0-4ea1-a483-bea2da030f77","name":"Update with Email","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ]\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Aug 2021 13:08:39 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"code\": \"ATT3HBIVHA6TC7UBMM7W80L82KM1\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=GHI123\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"code\": \"ATT52RJ426BNUE610TN67PT6U9Y3\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n }\n]"},{"id":"66cf47c2-a0c2-47f4-af0f-1fb568372b81","name":"Update with Code","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"code\": \"ATT3HBIVHA6TC7UBMM7W80L82KM1\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ]\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"code\": \"ATT52RJ426BNUE610TN67PT6U9Y3\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Aug 2021 13:09:22 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"code\": \"ATT3HBIVHA6TC7UBMM7W80L82KM1\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=GHI123\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"code\": \"ATT52RJ426BNUE610TN67PT6U9Y3\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGITHJ0Q6X\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n }\n]"}],"_postman_id":"9cc2538d-d7e0-43b0-b702-ae56fe6c8cc4"},{"name":"Delete Attendee","event":[{"listen":"test","script":{"id":"6ab3cd8e-472a-4dfe-803e-a1617d95e8d0","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});",""],"type":"text/javascript"}}],"id":"1e88778e-f26f-4277-a84a-c33611c0ce99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/ATTENDEE-CODE/","description":"Removes the Attendee from the chosen event. If the Attendee is still attending other events, they will not be removed from them.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendees","ATTENDEE-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"77843166-1ce7-4a73-be15-3d23c9b8131d","name":"Delete Attendee","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendees/ATTENDEE-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Aug 2021 15:47:30 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100.0\n },\n \"about\": \"CEO and space traveller.\",\n \"code\": \"ATTENDEE-CODE\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"206-266-1000\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n}"}],"_postman_id":"1e88778e-f26f-4277-a84a-c33611c0ce99"},{"name":"Bulk Delete Attendee","event":[{"listen":"test","script":{"id":"c2de57c0-446b-49ed-a6a0-ee2a712e96a4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[0]).to.have.all.keys(pm.collectionVariables.get(\"eventAttendeeFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"3c9b57d6-d935-4981-981a-5b075ebdc0e5","exec":["postman.setNextRequest(null);"],"type":"text/javascript"}}],"id":"d06f043b-008e-484a-bf9a-5916623da59d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\n \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"MEMBER-CODE\",\n \"{{Created Member Code 1}}\",\n \"{{Created Member Code 2}}\"\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/","description":"Removes the list of Attendees from the chosen event. If the Attendee is still attending other events, they will not be removed from them.
\nAccepts an object with a key of codes. This key should contain a list of Attendee (or Member) codes, to be deleted.
The endpoint returns all attendees deleted.
\nIf a passed Attendee Code can not be found, that Attendee will not be removed from your Event. Instead an entry in the response list with the first key of 'warning' and a value of Attendees not found will be added. This entry will contain a list of codes for all missing Attendees. It is a good idea to check if this object exists in the response to validate all expected Attendees are removed.
If other Attendees were removed successfully, they will still be returned as normal (alongside the warning object) in the response.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendeesbulk",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2f4141ff-0cf5-4ce9-a80a-518ff9f9a146","name":"Bulk Delete Attendee","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\n \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\"\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 17:27:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook1@apple.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100.0\n },\n \"about\": \"CEO of Apple.\",\n \"code\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC123\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n },\n {\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook2@apple.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100.0\n },\n \"about\": \"CEO of Apple.\",\n \"code\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"external_qr_code_url\": \"https://example.com/profile?pl_code=ABC456\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"metadata\": {},\n \"is_checked_in\": true,\n \"checkin_date\": \"2024-11-08 21:10:02\"\n }\n]"},{"id":"3106dff1-ab89-4f44-9adb-23a5f3b95218","name":"Bulk Delete Missing Attendees","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\n \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"MEMBER-CODE\",\n \"{{Created Member Code 1}}\",\n \"{{Created Member Code 2}}\"\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendeesbulk/"},"status":"NOT FOUND","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 17:22:28 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, PATCH, DELETE, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"warning\": \"Attendees not found\",\n \"codes\": [\n \"ATTU11MS9L17Y8ZSJSBQU59RKUMQ\",\n \"ATTXKYDNFC19N1I9JH2PXM9K396I\",\n \"ATTQGT9DDFU3V9EOFP5VSIKMPAZG\",\n \"ATTU11MS9L17Y8ZSJSBQU59RKUMQ\",\n \"ATTXKYDNFC19N1I9JH2PXM9K396I\"\n ]\n }\n]"}],"_postman_id":"d06f043b-008e-484a-bf9a-5916623da59d"}],"id":"0ad1c4ca-4622-465b-ab70-301d9bc992cc","description":"An Attendee in PheedLoop are your users that attend an event. When a user registers for your event, they either have an Attendee profile created if they are a new user, or their existing Attendee profile is updated to show they are now attending the new event.
\nAttendees and Members share the same underlying data model, but the object is referred to as an Attendee when dealing with Event level interactions, and a Member when dealing with Organization level interactions.
\nAttendees can be viewed in the Dashboard under your chosen Event -> Attendees. This is the list of all Attendees currently attending your event. To see all Attendees accross all your events (aka Members) please refer to Members.
\nSeveral endpoints are available for getting, creating, updating, and deleting Attendees within the PheedLoop system. All of the Attendee endpoints are event specific and require an event_code in their URL.
List all the events in your organization.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
This endpoint allows the follwing fields when using query parameters.
\ndate_updated_gte – Return events updated on or after this date. Format: YYYY-MM-DD
date_updated_lte – Return events updated on or before this date. Format: YYYY-MM-DD
virtual_enabled – Filter by virtual events. Accepts: true or false
For example: ?date_updated_gte=2025-01-01&virtual_enabled=true
Gets a single event, based on the Event Code passed in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"96477d07-635e-45d1-b4d4-29725efd4d71","name":"Get Single Event","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 17:31:59 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 26345,\n \"code\": \"{{eventCode}}\",\n \"user\": \"john@niantic.com\",\n \"event_name\": \"Anti-Chicken Wing Convention\",\n \"description\": \"Chicken Wings are awful and must be stopped!\",\n \"date\": \"2022-02-02\",\n \"end_date\": \"2022-02-04\",\n \"total_user_credits\": 50,\n \"remaining_user_credits\": 12,\n \"time_start\": \"10:56:55\",\n \"time_end\": \"10:56:59\",\n \"location\": \"Toronto\",\n \"credit_value\": 0.0,\n \"topics\": [\n {\n \"name\": \"test\",\n \"code\": \"ET5E5EDIAI3T\"\n }\n ],\n \"formats\": [\n {\n \"name\": \"test\",\n \"code\": \"EFTCZW5J70DH\"\n }\n ],\n \"timezone\": \"America/Toronto\",\n \"virtual_enabled\": true,\n \"learning_objectives\": \"\",\n \"custom_fields\": [\n {\n \"code\": \"CFDJG03PGVN12698K08\",\n \"name\": \"diet_restrictions\",\n \"type\": \"TEXT\",\n \"label\": \"Dietary Restrictions\",\n \"value\": [\n \"vegeterian\"\n ],\n \"options\": [],\n \"is_required\": false\n },\n {\n \"code\": \"CFD0OQR72VUKA76E84X\",\n \"name\": \"country\",\n \"type\": \"TEXT\",\n \"label\": \"country\",\n \"value\": [\n \"Canada\"\n ],\n \"options\": [],\n \"is_required\": false\n },\n {\n \"code\": \"CFDIUO61YS83AAJ8N5I\",\n \"name\": \"time\",\n \"type\": \"TEXT\",\n \"label\": \"time\",\n \"value\": [\n \"evening\"\n ],\n \"options\": [],\n \"is_required\": false\n }\n ],\n \"is_listed\": true,\n \"attendee_registration_capacity\": 0,\n \"total_registration_count\": 0\n}"}],"_postman_id":"10a7e54a-9144-4236-af77-55ed0053876a"},{"name":"Update Event","event":[{"listen":"test","script":{"id":"cd1ce0b3-387d-4331-9c2d-65873a2357a9","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All expected fields are returned in response\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"eventFields\"));","});"],"type":"text/javascript","packages":{}}}],"id":"ad3373a7-4658-4adc-add1-4e47c01c8439","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/","description":"Update a single Event, based on their code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"dffba21a-c37e-434c-a5f6-8daa37c8b4f7","name":"Update Event","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"custom_fields\": {\n \"CFD03X6YKE1S21NQUNG\": \"7381393\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 27 Nov 2024 15:01:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"5702"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 26345,\n \"code\": \"{{eventCode}}\",\n \"user\": \"john@niantic.com\",\n \"event_name\": \"Anti-Chicken Wing Convention\",\n \"description\": \"Chicken Wings are awful and must be stopped!\",\n \"date\": \"2022-02-02\",\n \"end_date\": \"2022-02-04\",\n \"total_user_credits\": 50,\n \"remaining_user_credits\": 12,\n \"time_start\": \"10:56:55\",\n \"time_end\": \"10:56:59\",\n \"location\": \"Toronto\",\n \"credit_value\": 0.0,\n \"topics\": [\n {\n \"name\": \"test\",\n \"code\": \"ET5E5EDIAI3T\"\n }\n ],\n \"formats\": [\n {\n \"name\": \"test\",\n \"code\": \"EFTCZW5J70DH\"\n }\n ],\n \"timezone\": \"America/Toronto\",\n \"virtual_enabled\": true,\n \"learning_objectives\": \"\",\n \"custom_fields\": [\n {\n \"code\": \"CFD03X6YKE1S21NQUNG\",\n \"name\": \"event_gl_number\",\n \"label\": \"Event General Ledger\",\n \"value\": \"7381392\"\n }\n ],\n \"is_listed\": true\n}"}],"_postman_id":"ad3373a7-4658-4adc-add1-4e47c01c8439"}],"id":"267be724-7735-44d0-98b2-5f53528bed24","description":"Events in the PheedLoop system are tied to your Organization and are where you and your Attendees will spend most of their time within the software.
\nEvents contain all information about each specific event including start and end times, sessions, speakers, exhibitors and more. Events are accessible from the main dashboard page under the button called Events. You may also find them under the Account Menu (the gear on the top right), All Events.
\nEach Event has a specific Event Code, accessible in the URLs for the event and from the List Events endpoint.
\n","event":[{"listen":"prerequest","script":{"id":"7e15cfed-0dc5-47f8-96c1-4367afd10519","type":"text/javascript","requests":{},"exec":["pm.collectionVariables.set(\"eventFields\","," ["," \"id\","," \"code\","," \"custom_slug\","," \"user\","," \"event_name\","," \"description\","," \"date\","," \"end_date\","," \"total_user_credits\","," \"remaining_user_credits\","," \"time_start\","," \"time_end\","," \"location\","," \"credit_value\","," \"topics\","," \"formats\","," \"timezone\","," \"virtual_enabled\","," \"learning_objectives\","," \"custom_fields\","," \"date_created\","," \"date_updated\","," \"is_listed\","," \"attendee_registration_capacity\","," \"total_registration_count\""," ]",");"]}},{"listen":"test","script":{"id":"3afcf5e3-894c-48dd-8fe9-d15eef98f4ff","type":"text/javascript","requests":{},"exec":[""]}}],"_postman_id":"267be724-7735-44d0-98b2-5f53528bed24"},{"name":"Event Attendance","item":[{"name":"Get Event Attendance","id":"c30e3328-75c7-4896-9561-45182778aaf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendance/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","attendance",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"7d983760-8c5a-4414-8357-3c32f65df7f0","name":"Get Event Attendance","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/attendance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Jun 2024 15:34:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"191"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.27.0"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"X-Amzn-Trace-Id","value":"Root=1-00000000-000000000000000000000000"},{"key":"Origin-Trial","value":"AsEHT2MnNf9P5HbnrfsTtHOqZZjgCSb8Wuw1+i/mrHqTqI0JvbD7huI/yH7Zyt4wQ+J7NjQX7auKJjGigphJGQUAAAB3eyJvcmlnaW4iOiJodHRwczovL3BoZWVkbG9vcC5jb206NDQzIiwiZmVhdHVyZSI6IlVucmVzdHJpY3RlZFNoYXJlZEFycmF5QnVmZmVyIiwiZXhwaXJ5IjoxNzA5ODU1OTk5LCJpc1N1YmRvbWFpbiI6dHJ1ZX0="}],"cookie":[],"responseTime":null,"body":"{\n \"checked_in\": [\n \"ATT5QTQS3NY2GZF74SQDZ2XFYD5F\",\n \"ATTA6QKH3UUZX0UPCIH5PFGHKTIA\"\n ],\n \"not_checked_in\": [\n \"ATTA6QKH3UUZX0UPCIH5PFGHKTIA\",\n \"ATT3OWAPPCM1LGGHLHK8998GHFD4\",\n \"ATTF9O6HSPUZOVG7M550PKQTR4DK\",\n \"ATT4F9BL93H4IHI31YH2U08542TH\"\n ]\n}"}],"_postman_id":"c30e3328-75c7-4896-9561-45182778aaf3"},{"name":"Event CheckIn","event":[{"listen":"test","script":{"id":"70c5e920-6ffe-42ca-83fc-b4cc1598d187","exec":["pm.test(\"Test if post event checkin return 201\", function () {"," pm.expect(pm.response.code).to.equal(201);","});","",""],"type":"text/javascript"}}],"id":"7d868344-88fa-4774-8727-d5e8ea905060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\"\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/checkin/","description":"This endpoint processes a list of attendee codes and straightforwardly create event checkin with attendee that correspond to the provided codes.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","checkin",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"98823848-0513-4dae-9ae3-fbafc4edb1fe","name":"Event Checkin","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"codes\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/checkin/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Tue, 02 Jan 2024 19:57:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"55"}],"cookie":[],"responseTime":null,"body":"{\n \"attendees\": [\n \"ATTCUJWRY88GL3VBV01LNMDJU4CH\"\n ],\n \"errored_attendees\": []\n}"}],"_postman_id":"7d868344-88fa-4774-8727-d5e8ea905060"},{"name":"Event CheckOut","event":[{"listen":"test","script":{"id":"70c5e920-6ffe-42ca-83fc-b4cc1598d187","exec":["pm.test('Test attendee event checkout return status 204', function () {"," pm.expect(pm.response.code).to.equal(204);","})",""],"type":"text/javascript"}}],"id":"444aa97e-77f6-48a3-afdb-6cbc8e4135e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\"\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/checkout/","description":"This endpoint processes a list of attendee codes and straightforwardly checkout the attendees from the existing event attendees.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","checkout",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"9adc2925-797d-4909-8fce-5710d37ea471","name":"Event CheckOut","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"codes\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/checkout/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Tue, 02 Jan 2024 21:46:06 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"444aa97e-77f6-48a3-afdb-6cbc8e4135e2"}],"id":"7c5ab4cf-ddc3-4838-b524-0d47351393b8","description":"The Event Check In/Out API enables users to manage attendee check-ins for specific events.
\nAttendee can be Checked In and Out of an Event on the dashboard under the All Events -> Attendee, select a specific attendee and click the action button you will see a Check In / Out option however this operation can also be perform via the API.
\n","_postman_id":"7c5ab4cf-ddc3-4838-b524-0d47351393b8"},{"name":"Registrations","item":[{"name":"List Registrations","event":[{"listen":"test","script":{"id":"4a1b8993-3a49-44d9-af12-41146036dbb4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[\"results\"][0]).to.have.all.keys(pm.collectionVariables.get(\"registrationFields\"))","});"],"type":"text/javascript","packages":{}}}],"id":"70bb6eca-792b-41d6-a69e-155bac7782cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/registrations/?page_size=5","description":"Returns a list of all registrations for your event, each item in the list contains several useful fields showing information regarding the registration.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You can filter the data to retrieve specific results. The available filterable fields for this endpoint are:
\ndate_updated_gte - Return registrations updated on or after this date. Format: YYYY-MM-DD
date_updated_lte - Return registrations updated on or before this date. Format: YYYY-MM-DD
Please note that search functionality is not supported on this endpoint.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","registrations",""],"host":["{{baseURL}}api"],"query":[{"key":"page_size","value":"5"}],"variable":[]}},"response":[{"id":"a476e229-fbd6-4b0d-948e-0a5b522ae885","name":"List Registrations","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/registrations/?page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","registrations",""],"query":[{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Nov 2021 21:28:25 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/registrations/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"REG1GWPXQGP\",\n \"organization_code\": \"{{organizationCode}}\",\n \"event_code\": \"{{eventCode}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"attendee_code\": \"ATTSZ2OF1H15A4T72JZ58DQF2Q9P\",\n \"organization\": \"Niantic\",\n \"code_internal\": \"\",\n \"title\": \"CEO\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"registration_complete\": true,\n \"canceled\": false,\n \"paid\": true,\n \"date\": \"2021-11-04T18:09:33.201640Z\",\n \"purchases\": [],\n \"discounts\": [],\n \"refunds\": [],\n \"sub_total\": 85.0,\n \"tax_total\": 11.05,\n \"payment_total\": 113.0,\n \"refund_total\": 0.0,\n \"amount_due\": 0.0,\n \"charge_id\": \"st_sample000abc\",\n \"promotion\": \"PROCBKUBYSO\",\n \"refund_id\": \"\",\n \"refund_date\": null,\n \"notes\": \"\",\n \"form_response\": [\n {\n \"answer\": \"What is your favourite Pokemon?\",\n \"question\": \"Tentacruel\"\n }\n ],\n \"registration_category\": {\n \"code\": \"CAT3D6BKF6N\",\n \"name\": \"Sponsor\"\n },\n \"custom_fields\": [\n {\n \"code\": \"CFD3QFONXHMHE41H8Z1\",\n \"name\": \"gl_code\",\n \"label\": \"GL Code\",\n \"value\": \"219301\"\n }\n ],\n \"utm_source\": \"reddit\",\n \"utm_medium\": \"post\",\n \"utm_campaign\": \"community\",\n \"utm_content\": \"discussion\",\n \"utm_term\": \"signup\"\n }\n ]\n}"}],"_postman_id":"70bb6eca-792b-41d6-a69e-155bac7782cf"},{"name":"List Ticket Purchases","event":[{"listen":"test","script":{"id":"41ba5683-3e9a-443d-bac6-c54023aebe58","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[\"results\"][0]).to.have.all.keys(pm.collectionVariables.get(\"ticketPurchaseFields\"));","});",""],"type":"text/javascript","packages":{}}}],"id":"8fc8ae5f-51a7-46ba-a5f4-278c25fcaee9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/ticketpurchases/","description":"Returns a list of all ticket purchases for your event, each item in the list contains several useful fields showing information regarding the purchase.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You can filter the data to retrieve specific results. The available filterable fields for this endpoint are:
\nregistration_id
date_cancelled_gte - Return ticket purchases cancelled on or after this date. Format: YYYY-MM-DD
date_cancelled_lte - Return ticket purchases cancelled on or before this date. Format: YYYY-MM-DD
Please note that search functionality is not supported on this endpoint.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","ticketpurchases",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"efc9da11-c45f-43c8-bcab-8a656e2524a1","name":"List Ticket Purchases","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/ticketpurchases/?page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","ticketpurchases",""],"query":[{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Nov 2021 21:41:12 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/ticketpurchases/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"PUR6B49JOSP\",\n \"event\": \"EVEPLTXAWUFQQ\",\n \"organization_code\": \"{{organizationCode}}\",\n \"attendee_code\": \"ATTSZ2OF1H15A4T72JZ58DQF2Q9P\",\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"organization\": \"Niantic\",\n \"code_internal\": \"\",\n \"title\": \"CEO\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"dietary_restrictions\": \"Gluten\",\n \"registrant_first_name\": \"John\",\n \"registrant_last_name\": \"Hanke\",\n \"registrant_email\": \"john@niantic.com\",\n \"registrant_organization\": \"Niantic\",\n \"registrant_title\": \"Event Planner\",\n \"registrant_code\": \"ATT2BMIFD709ECBS5WSA7RY38EI5\",\n \"registrant_custom_fields\":{\n \"personId\": \"89023\"\n },\n \"registrant_code_internal\": \"\",\n \"ticket_name\": \"Sample ticket\",\n \"ticket_code\": \"TICGP3GX7KP\",\n \"ticket_price\": 100,\n \"ticket_description\": \"\",\n \"paid\": true,\n \"date\": \"2021-11-04T18:09:33.425842Z\",\n \"is_canceled\": false,\n \"checked_in\": false,\n \"checked_in_date\": null,\n \"registration_complete\": true,\n \"registration_id\": \"REG1GWPXQGP\",\n \"registration_date\": \"2021-11-04T18:09:33.201640Z\",\n \"sub_total\": 85,\n \"tax_total\": 11.05,\n \"payment_total\": 96.05,\n \"charge_id\": \"st_sample000abc\",\n \"promotion\": \"PROCBKUBYSO\",\n \"form_response\": [\n {\n \"answer\": \"What is your favourite Pokemon?\",\n \"question\": \"Tentacruel\"\n }\n ],\n \"registrant_tags\": [\n {\n \"name\": \"Speaker\",\n \"code\": \"TAGOM4HRPPG\"\n }\n ],\n \"custom_fields\": [\n {\n \"code\": \"CFD3QFONXHMHE41H8Z1\",\n \"name\": \"gl_code\",\n \"label\": \"GL Code\",\n \"value\": \"219301\"\n }\n ]\n }\n ]\n}"},{"id":"00c55405-b761-4feb-bbbc-53f9be6fc0a1","name":"Filter Ticket Purchases","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/ticketpurchases/?page_size=1®istration_id=REG1GWPXQGP&date_cancelled_gte=2025-03-21&date_cancelled_lte=2025-03-22","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","ticketpurchases",""],"query":[{"key":"page_size","value":"1"},{"key":"registration_id","value":"REG1GWPXQGP"},{"key":"date_cancelled_gte","value":"2025-03-21"},{"key":"date_cancelled_lte","value":"2025-03-22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"PUR6B49JOSP\",\n \"event\": \"EVEPLTXAWUFQQ\",\n \"organization_code\": \"{{organizationCode}}\",\n \"attendee_code\": \"ATTSZ2OF1H15A4T72JZ58DQF2Q9P\",\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"organization\": \"Niantic\",\n \"title\": \"CEO\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"tags\": [\n \"TAGOM4HRPPG\"\n ],\n \"dietary_restrictions\": \"Gluten\",\n \"registrant_first_name\": \"John\",\n \"registrant_last_name\": \"Hanke\",\n \"registrant_email\": \"john@niantic.com\",\n \"registrant_organization\": \"Niantic\",\n \"registrant_title\": \"Event Planner\",\n \"registrant_code\": \"ATT2BMIFD709ECBS5WSA7RY38EI5\",\n \"registrant_custom_fields\": {\n \"personId\": \"89023\"\n },\n \"registrant_code_internal\": \"\",\n \"ticket_name\": \"Sample ticket\",\n \"ticket_code\": \"TICGP3GX7KP\",\n \"ticket_price\": 100,\n \"ticket_description\": \"\",\n \"paid\": true,\n \"date\": \"2021-11-04T18:09:33.425842Z\",\n \"is_canceled\": false,\n \"checked_in\": false,\n \"checked_in_date\": null,\n \"registration_complete\": true,\n \"registration_id\": \"REG1GWPXQGP\",\n \"registration_date\": \"2021-11-04T18:09:33.201640Z\",\n \"sub_total\": 85,\n \"tax_total\": 11.05,\n \"payment_total\": 96.05,\n \"charge_id\": \"st_sample000abc\",\n \"promotion\": \"PROCBKUBYSO\",\n \"form_response\": [\n {\n \"answer\": \"What is your favourite Pokemon?\",\n \"question\": \"Tentacruel\"\n }\n ],\n \"registrant_tags\": [],\n \"custom_fields\": [\n {\n \"code\": \"CFD3QFONXHMHE41H8Z1\",\n \"name\": \"gl_code\",\n \"label\": \"GL Code\",\n \"value\": \"219301\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"8fc8ae5f-51a7-46ba-a5f4-278c25fcaee9"}],"id":"a8fbe020-19f7-446c-97cf-233c786b2aa3","description":"A Registration is created when a user registers for one of your Events. The Registration model contains all properties about how the user registered for your Event, including pricing and form responses.
\nRegistrations are accessible from the Dashboard under your chosen Event -> Registrations -> Orders. You may manually create them here or these will be created as Attendees register for your event.
\n","event":[{"listen":"prerequest","script":{"id":"319da946-e427-43ce-8946-7130314cd235","type":"text/javascript","exec":["pm.collectionVariables.set(\"registrationFields\","," ["," \"code\","," \"event_code\","," \"organization_code\","," \"attendee_code\","," \"first_name\","," \"last_name\","," \"email\","," \"organization\","," \"title\","," \"address_line_1\","," \"address_line_2\","," \"address_city\","," \"address_state\","," \"address_zip\","," \"address_country\","," \"code_internal\","," \"address_phone\","," \"registration_complete\","," \"canceled\","," \"paid\","," \"date\","," \"purchases\","," \"payments\","," \"discounts\","," \"refunds\","," \"surcharges\","," \"sub_total\","," \"tax_total\","," \"payment_total\","," \"refund_total\","," \"amount_due\","," \"charge_id\","," \"promotion\","," \"refund_id\","," \"refund_date\","," \"notes\","," \"form_response\","," \"registration_category\","," \"custom_fields\","," \"date_updated\","," \"date_cancelled\","," \"utm_source\","," \"utm_medium\","," \"utm_campaign\","," \"utm_content\","," \"utm_term\","," ]",");","","pm.collectionVariables.set(\"ticketPurchaseFields\","," ["," \"code\","," \"event\","," \"organization_code\","," \"first_name\","," \"last_name\","," \"email\","," \"attendee_code\","," \"code_internal\","," \"organization\","," \"title\","," \"address_line_1\","," \"address_line_2\","," \"address_city\","," \"address_state\","," \"address_zip\","," \"address_country\","," \"address_phone\","," \"tags\","," \"dietary_restrictions\","," \"registrant_first_name\","," \"registrant_last_name\","," \"registrant_email\","," \"registrant_organization\","," \"registrant_title\","," \"registrant_code\","," \"registrant_custom_fields\","," \"registrant_code_internal\","," \"ticket_name\","," \"ticket_code\","," \"ticket_price\","," \"purchase_price\","," \"final_price\","," \"discounts\","," \"ticket_description\","," \"paid\","," \"date\","," \"date_updated\","," \"date_cancelled\","," \"is_canceled\","," \"checked_in\","," \"checked_in_date\","," \"registration_complete\","," \"registration_id\","," \"registration_date\","," \"sub_total\","," \"tax_total\","," \"payment_total\","," \"charge_id\","," \"promotion\","," \"form_response\","," \"registrant_tags\","," \"custom_fields\""," ]",");"]}},{"listen":"test","script":{"id":"07c5d434-a2e2-4dcc-99e9-a744521d022c","type":"text/javascript","exec":[""]}}],"_postman_id":"a8fbe020-19f7-446c-97cf-233c786b2aa3"},{"name":"Tickets","item":[{"name":"List Tickets","event":[{"listen":"test","script":{"id":"ad4e0f98-95e2-4ce3-ab60-b67226d76d36","exec":["pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.equal(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()['results'][0]).to.have.all.keys(pm.collectionVariables.get(\"ticketFields\"));","});","","pm.collectionVariables.set(\"ticketCode\", pm.response.json()['results'][0]['code']);",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4ca1b5e1-456f-4b42-9505-88e903a136ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/tickets/","description":"Returns a paginated list of tickets for your organization. Each item includes key fields describing the ticket.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You can filter the data to retrieve specific results. The available filterable fields for this endpoint are:
\nevent_code - Returns tickets that belongs to the specified event.Please note that search functionality is not supported on this endpoint.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","tickets",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"d5fb199c-da45-444a-97ec-42ded8dd4012","name":"List Tickets","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/tickets/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 179,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"event_code\": \"EVEHRNFBNPPSX\",\n \"code\": \"TICCYSN13IK\",\n \"name\": \"ResMania 2025 Early Bird General Registration\",\n \"description\": \"Sample ticket description.\",\n \"price\": 100.0,\n \"start_date\": \"2024-08-19\",\n \"end_date\": \"2024-12-20\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"23:59:59\",\n \"limit_per_order\": 10,\n \"minimum_per_order\": 1,\n \"limit_per_attendee\": null,\n \"minimum_per_attendee\": null,\n \"quantity_available\": null,\n \"is_addon\": false,\n \"is_active\": true,\n \"is_private\": false,\n \"is_virtual\": false,\n \"is_protected\": false,\n \"is_sold_in_app\": false,\n \"is_sold_in_site\": true,\n \"is_waitlist_enabled\": false,\n \"is_waitlist_notification_enabled\": false,\n \"is_group_details_required\": true,\n \"is_text_overflow_hidden\": false,\n \"is_visible_unavailable\": false,\n \"is_disabled_email_confirmation\": false,\n \"is_member_only\": false,\n \"allow_guest_purchases\": false,\n \"show_as_sold_out\": false,\n \"enforce_unique_purchase\": false,\n \"enable_pdf_qr_code\": true,\n \"break_1_quantity\": null,\n \"break_2_quantity\": null,\n \"break_3_quantity\": null,\n \"break_1_price\": null,\n \"break_2_price\": null,\n \"break_3_price\": null,\n \"country_whitelist\": \"\",\n \"country_blacklist\": null,\n \"registration_categories\": [\n {\n \"code\": \"CATENBGH3NL\",\n \"name\": \"Attendee\"\n }\n ],\n \"categories_sub\": [],\n \"sessions\": [],\n \"tags\": [],\n \"contact_tags\": [],\n \"contact_tags_exclusions\": [],\n \"custom_fields\": [\n {\n \"code\": \"CFDCR3XLRDAS7UV7NMV\",\n \"name\": \"gl_code\",\n \"type\": \"TEXT\",\n \"label\": \"gl_code\",\n \"value\": [],\n \"options\": [],\n \"is_required\": true\n }\n ]\n }\n ]\n}"}],"_postman_id":"4ca1b5e1-456f-4b42-9505-88e903a136ce"},{"name":"Get Single Ticket","id":"32b3f9c2-4e48-490b-ae52-570a0735535d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/tickets//","description":"Returns a single ticket within your organization, includes key fields describing the ticket.
\nYou can filter the data to retrieve specific results. The available filterable fields for this endpoint are:
\nevent_code - Returns tickets that belongs to the specified event.Please note that search functionality is not supported on this endpoint.On
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","tickets","",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"b7729194-4532-4dc9-8ded-c342aca080d4","name":"Get Single Ticket","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/tickets//"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"event_code\": \"EVEHRNFBNPPSX\",\n \"code\": \"TICCYSN13IK\",\n \"name\": \"ResMania 2025 Early Bird General Registration\",\n \"description\": \"Sample ticket description.\",\n \"price\": 100,\n \"start_date\": \"2024-08-19\",\n \"end_date\": \"2024-12-20\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"23:59:59\",\n \"limit_per_order\": 10,\n \"minimum_per_order\": 1,\n \"limit_per_attendee\": null,\n \"minimum_per_attendee\": null,\n \"quantity_available\": null,\n \"is_addon\": false,\n \"is_active\": true,\n \"is_private\": false,\n \"is_virtual\": false,\n \"is_protected\": false,\n \"is_sold_in_app\": false,\n \"is_sold_in_site\": true,\n \"is_waitlist_enabled\": false,\n \"is_waitlist_notification_enabled\": false,\n \"is_group_details_required\": true,\n \"is_text_overflow_hidden\": false,\n \"is_visible_unavailable\": false,\n \"is_disabled_email_confirmation\": false,\n \"is_member_only\": false,\n \"allow_guest_purchases\": false,\n \"show_as_sold_out\": false,\n \"enforce_unique_purchase\": false,\n \"enable_pdf_qr_code\": true,\n \"break_1_quantity\": null,\n \"break_2_quantity\": null,\n \"break_3_quantity\": null,\n \"break_1_price\": null,\n \"break_2_price\": null,\n \"break_3_price\": null,\n \"country_whitelist\": \"\",\n \"country_blacklist\": null,\n \"registration_categories\": [\n {\n \"code\": \"CATENBGH3NL\",\n \"name\": \"Attendee\"\n }\n ],\n \"categories_sub\": [],\n \"sessions\": [],\n \"tags\": [],\n \"contact_tags\": [],\n \"contact_tags_exclusions\": [],\n \"custom_fields\": [\n {\n \"code\": \"CFDCR3XLRDAS7UV7NMV\",\n \"name\": \"gl_code\",\n \"type\": \"TEXT\",\n \"label\": \"gl_code\",\n \"value\": [],\n \"options\": [],\n \"is_required\": true\n }\n ]\n}"}],"_postman_id":"32b3f9c2-4e48-490b-ae52-570a0735535d"}],"id":"e4572c33-af68-4d1e-9aac-2ce423b793dd","event":[{"listen":"prerequest","script":{"id":"d5ea02e5-d20a-45a8-9fea-587c30d19986","type":"text/javascript","packages":{},"requests":{},"exec":["pm.collectionVariables.set(\"ticketFields\", "," ["," \"event_code\","," \"code\","," \"name\","," \"description\","," \"price\","," \"start_date\","," \"end_date\","," \"start_time\","," \"end_time\","," \"limit_per_order\","," \"minimum_per_order\","," \"limit_per_attendee\","," \"minimum_per_attendee\","," \"quantity_available\","," \"is_addon\","," \"is_active\","," \"is_private\","," \"is_virtual\","," \"is_protected\","," \"is_sold_in_app\","," \"is_sold_in_site\","," \"is_waitlist_enabled\","," \"is_waitlist_notification_enabled\","," \"is_group_details_required\","," \"is_text_overflow_hidden\","," \"is_visible_unavailable\","," \"is_disabled_email_confirmation\","," \"is_member_only\","," \"allow_guest_purchases\","," \"show_as_sold_out\","," \"enforce_unique_purchase\","," \"enable_pdf_qr_code\","," \"break_1_quantity\","," \"break_2_quantity\","," \"break_3_quantity\","," \"break_1_price\","," \"break_2_price\","," \"break_3_price\","," \"country_whitelist\","," \"country_blacklist\","," \"registration_categories\","," \"categories_sub\","," \"ticket_form\","," \"sessions\","," \"tags\","," \"contact_tags\","," \"contact_tags_exclusions\","," \"custom_fields\","," \"date_updated\""," ]",");"]}},{"listen":"test","script":{"id":"110502d8-8230-46ee-88f5-9ddb570725c1","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"e4572c33-af68-4d1e-9aac-2ce423b793dd","description":""},{"name":"Ticket Transfer Logs","item":[{"name":"List Ticket Transfer Logs","event":[{"listen":"test","script":{"id":"a127190d-b3fd-4866-9ddd-45961105e369","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[\"results\"][0]).to.have.all.keys(pm.collectionVariables.get(\"ticketTransferLogFields\"));","});","","pm.collectionVariables.set(\"ticketTransferCode\", pm.response.json()['results'][0]['code']);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"71031874-4dea-456f-b03b-bfdb4689b241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/tickettransferlogs/","description":"Lists all Ticket Transfer and their information for your chosen event as determined by the Event Code.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nstatus: PENDING | COMPLETED | CANCELLED | EXPIRED
dateCreatedAfter: YYYY-MM-DD
\ndateCreatedBefore: YYYY-MM-DD
\nSearches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","tickettransferlogs",""],"host":["{{baseURL}}api"],"query":[{"disabled":true,"key":"dateCreatedAfter","value":"2025-08-12"},{"disabled":true,"key":"dateCreatedBefore","value":"2025-09-12"},{"disabled":true,"key":"status","value":"completed"}],"variable":[]}},"response":[{"id":"4272e93c-031c-4dac-b67b-a3c2de707c9b","name":"Ticket Transfer Logs","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/tickettransferlogs/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"TTR9U7GMV5RB52FEPX\",\n \"event_code\": \"EVENT_CODE\",\n \"transferred_by\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"attendee_code\": \"ATT4GC5616Q2OO0WO36TMRUZIMOV\",\n \"internal_code\": \"95650142\"\n },\n \"transferred_to\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@email.com\",\n \"attendee_code\": \"ATT4GC5616Q2OO0WO36TMRUZIMOZ\",\n \"internal_code\": \"95650143\"\n },\n \"transfer_date\": \"2025-09-12\",\n \"is_cancelled\": false,\n \"cancelled_by\": null,\n \"date_claimed\": \"2025-09-12\",\n \"status\": \"COMPLETED\",\n \"ticket\": {\n \"purchase_code\": \"PUR70F3SZFI\",\n \"ticket_code\": \"TICC9O4DAF4\",\n \"ticket_name\": \"EARLY BIRD Member - General Admission\"\n },\n \"registration_code\": \"REGK33AGJ2S\"\n },\n {\n \"code\": \"TTR9U7GMV5RB52FEPZ\",\n \"event_code\": \"EVENT_CODE\",\n \"transferred_by\": {\n \"first_name\": \"Jone\",\n \"last_name\": \"Doe\",\n \"email\": \"jone.doe@email.com\",\n \"attendee_code\": \"ATT4GC5616Q2OO0WO36TMRUZIMOX\",\n \"internal_code\": \"95650145\"\n },\n \"transferred_to\": {\n \"first_name\": \"Mark\",\n \"last_name\": \"Watney\",\n \"email\": \"mark.w@email.com\"\n },\n \"transfer_date\": \"2025-09-15\",\n \"is_cancelled\": false,\n \"cancelled_by\": null,\n \"date_claimed\": null,\n \"status\": \"PENDING\",\n \"ticket\": {\n \"purchase_code\": \"PURH0MVMAMC\",\n \"ticket_code\": \"TICC9O4DAF9\",\n \"ticket_name\": \"EARLY BIRD Member - Backstage Pass\"\n },\n \"registration_code\": \"REG21H3BVOW\"\n }\n ]\n}"}],"_postman_id":"71031874-4dea-456f-b03b-bfdb4689b241"},{"name":"Get Ticket Transfer Logs","event":[{"listen":"test","script":{"id":"a127190d-b3fd-4866-9ddd-45961105e369","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"ticketTransferLogFields\"));","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b40dc30c-6142-4b81-a171-b592a8aece9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/tickettransferlogs/{{ticketTransferCode}}/","description":"Lists all Ticket Transfer and their information for your chosen event as determined by the Event Code.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nstatus: PENDING | COMPLETED | CANCELLED | EXPIRED
dateCreatedAfter: YYYY-MM-DD
\ndateCreatedBefore: YYYY-MM-DD
\nSearches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","tickettransferlogs","{{ticketTransferCode}}",""],"host":["{{baseURL}}api"],"query":[{"disabled":true,"key":"dateCreatedAfter","value":"2025-08-12"},{"disabled":true,"key":"dateCreatedBefore","value":"2025-09-12"},{"disabled":true,"key":"status","value":"completed"}],"variable":[]}},"response":[{"id":"9efe2cfe-747b-4d42-9ca7-8911e527e5ab","name":"Ticket Transfer Logs","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/tickettransferlogs/{{ticketTransferCode}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"TTR9U7GMV5RB52FEPX\",\n \"event_code\": \"EVENT_CODE\",\n \"transferred_by\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"attendee_code\": \"ATT4GC5616Q2OO0WO36TMRUZIMOV\",\n \"internal_code\": \"95650142\"\n },\n \"transferred_to\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@email.com\",\n \"attendee_code\": \"ATT4GC5616Q2OO0WO36TMRUZIMOZ\",\n \"internal_code\": \"95650143\"\n },\n \"transfer_date\": \"2025-09-12\",\n \"is_cancelled\": false,\n \"cancelled_by\": null,\n \"date_claimed\": \"2025-09-12\",\n \"status\": \"COMPLETED\",\n \"ticket\": {\n \"purchase_code\": \"PUR70F3SZFI\",\n \"ticket_code\": \"TICC9O4DAF4\",\n \"ticket_name\": \"EARLY BIRD Member - General Admission\"\n },\n \"registration_code\": \"REGK33AGJ2S\"\n}"}],"_postman_id":"b40dc30c-6142-4b81-a171-b592a8aece9d"}],"id":"ee8c5773-6416-4c2c-901a-bc1dae5fe1bc","event":[{"listen":"prerequest","script":{"id":"d8015b54-ef28-420e-882a-174946ffff7e","type":"text/javascript","packages":{},"requests":{},"exec":["","pm.collectionVariables.set(\"ticketTransferLogFields\","," ["," \"code\","," \"event_code\","," \"transferred_by\","," \"transferred_to\","," \"transfer_date\","," \"is_cancelled\","," \"cancelled_by\","," \"date_claimed\","," \"status\","," \"ticket\","," \"registration_code\""," ]",");"]}},{"listen":"test","script":{"id":"55379174-d0ed-4047-8698-701f59177867","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"ee8c5773-6416-4c2c-901a-bc1dae5fe1bc","description":""},{"name":"Surcharge","item":[{"name":"List Surcharges","event":[{"listen":"test","script":{"id":"4972f812-b074-409a-b733-e528dfea6bba","exec":["pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.equal(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()['results'][0]).to.have.all.keys(pm.collectionVariables.get(\"surchargeFields\"));","});","","pm.collectionVariables.set(\"surchargeCode\", pm.response.json()['results'][0]['code']);",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"96d969b2-3419-4d19-a783-815fc4c0c612","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/surcharges/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","surcharges",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"33b0b657-ccc9-4b3e-9fc6-c8e90d3b194a","name":"List Surcharges","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/surcharges/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.4"},{"key":"Date","value":"Wed, 15 Oct 2025 15:21:13 GMT"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"9022"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Origin-Trial","value":"AhwcWfE8G+cOvjhS+Rbrx7ghHUdaobE0nb07m2mlISpchxW3gTP2iwmS+EaJ105ob4tyM7zJrmGlSbKr8paIGQIAAAB3eyJvcmlnaW4iOiJodHRwczovL3BoZWVkbG9vcC5jb206NDQzIiwiZmVhdHVyZSI6IlVucmVzdHJpY3RlZFNoYXJlZEFycmF5QnVmZmVyIiwiZXhwaXJ5IjoxNzUzMTQyNDAwLCJpc1N1YmRvbWFpbiI6dHJ1ZX0="},{"key":"Permissions-Policy","value":"fullscreen=(self 'https://app.webinar.net' '*.clickmeeting.com' 'https://vimeo.com' 'https://player.vimeo.com')"},{"key":"Feature-Policy","value":"fullscreen 'self' https://app.webinar.net *.clickmeeting.com https://vimeo.com https://player.vimeo.com"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SRCHIHLMXH6E\",\n \"name\": \"Surcharge 1\",\n \"event_code\": \"{{eventCode}}\",\n \"flat_rate\": \"20.00\",\n \"percentage\": \"0.00\",\n \"date_created\": \"2025-06-11T18:27:31.021096Z\",\n \"category\": \"REGISTRATION\",\n \"date_updated\": \"2025-06-11T18:27:31.021122Z\",\n \"custom_fields\": [\n {\n \"code\": \"CFDCR3XLRDAS7UV7NMV\",\n \"name\": \"reason\",\n \"type\": \"TEXT\",\n \"label\": \"Reason\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ]\n },\n {\n \"code\": \"SRCHROM0RYGU\",\n \"name\": \"Surcharge 2\",\n \"flat_rate\": \"0.00\",\n \"percentage\": \"10.00\",\n \"date_created\": \"2025-08-11T15:33:45.554284Z\",\n \"category\": \"REGISTRATION\",\n \"date_updated\": \"2025-08-11T15:33:45.554305Z\",\n \"custom_fields\": [\n {\n \"code\": \"CFDCR3XLRDAS7UV7NMV\",\n \"name\": \"reason\",\n \"type\": \"TEXT\",\n \"label\": \"Reason\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ]\n }\n ]\n}"}],"_postman_id":"96d969b2-3419-4d19-a783-815fc4c0c612"},{"name":"Get Single Surcharges","id":"f93cd6b2-cd63-41b4-984a-e0c15f9af8ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/surcharges//","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","surcharges","",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"79daca41-b752-4eea-82a3-a0239a12fce8","name":"Get Single Surcharges","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/surcharges//"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.27.4"},{"key":"Date","value":"Wed, 15 Oct 2025 15:33:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1270"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Origin-Trial","value":"AhwcWfE8G+cOvjhS+Rbrx7ghHUdaobE0nb07m2mlISpchxW3gTP2iwmS+EaJ105ob4tyM7zJrmGlSbKr8paIGQIAAAB3eyJvcmlnaW4iOiJodHRwczovL3BoZWVkbG9vcC5jb206NDQzIiwiZmVhdHVyZSI6IlVucmVzdHJpY3RlZFNoYXJlZEFycmF5QnVmZmVyIiwiZXhwaXJ5IjoxNzUzMTQyNDAwLCJpc1N1YmRvbWFpbiI6dHJ1ZX0="},{"key":"Permissions-Policy","value":"fullscreen=(self 'https://app.webinar.net' '*.clickmeeting.com' 'https://vimeo.com' 'https://player.vimeo.com')"},{"key":"Feature-Policy","value":"fullscreen 'self' https://app.webinar.net *.clickmeeting.com https://vimeo.com https://player.vimeo.com"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SRCHIHLMXH6E\",\n \"name\": \"Surcharge 1\",\n \"event_code\": \"{{eventCode}}\",\n \"flat_rate\": \"20.00\",\n \"percentage\": \"0.00\",\n \"date_created\": \"2025-06-11T18:27:31.021096Z\",\n \"category\": \"REGISTRATION\",\n \"date_updated\": \"2025-06-11T18:27:31.021122Z\",\n \"custom_fields\": [\n {\n \"code\": \"CFDCR3XLRDAS7UV7NMV\",\n \"name\": \"reason\",\n \"type\": \"TEXT\",\n \"label\": \"Reason\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ]\n}"}],"_postman_id":"f93cd6b2-cd63-41b4-984a-e0c15f9af8ce"}],"id":"6467397f-3bed-4686-b21e-264b7db45da3","event":[{"listen":"prerequest","script":{"id":"76ed9670-ad85-4c8d-9c5c-ca8a0ee155bc","type":"text/javascript","packages":{},"requests":{},"exec":["pm.collectionVariables.set(\"surchargeFields\", "," ["," \"code\","," \"name\","," \"event_code\","," \"flat_rate\","," \"percentage\","," \"date_created\","," \"category\","," \"date_updated\","," \"custom_fields\""," ]",");"]}},{"listen":"test","script":{"id":"45565dd5-3264-4fc5-9996-238caec30138","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"6467397f-3bed-4686-b21e-264b7db45da3","description":""},{"name":"Registration Promotion","item":[{"name":"List Promotions","event":[{"listen":"test","script":{"id":"4972f812-b074-409a-b733-e528dfea6bba","exec":["pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.equal(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()['results'][0]).to.have.all.keys(pm.collectionVariables.get(\"registrationPromotionFields\"));","});","","pm.collectionVariables.set(\"registrationPromotionCode\", pm.response.json()['results'][0]['code']);",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"56a6d318-0e3d-4803-b46f-e77977621f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/registrations/promotions/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","registrations","promotions",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"ff1837dc-5c47-4e36-a5cd-ffbab6254ccb","name":"List Promotions","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/registration/promotions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.4"},{"key":"Date","value":"Wed, 15 Oct 2025 15:21:13 GMT"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"9022"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Origin-Trial","value":"AhwcWfE8G+cOvjhS+Rbrx7ghHUdaobE0nb07m2mlISpchxW3gTP2iwmS+EaJ105ob4tyM7zJrmGlSbKr8paIGQIAAAB3eyJvcmlnaW4iOiJodHRwczovL3BoZWVkbG9vcC5jb206NDQzIiwiZmVhdHVyZSI6IlVucmVzdHJpY3RlZFNoYXJlZEFycmF5QnVmZmVyIiwiZXhwaXJ5IjoxNzUzMTQyNDAwLCJpc1N1YmRvbWFpbiI6dHJ1ZX0="},{"key":"Permissions-Policy","value":"fullscreen=(self 'https://app.webinar.net' '*.clickmeeting.com' 'https://vimeo.com' 'https://player.vimeo.com')"},{"key":"Feature-Policy","value":"fullscreen 'self' https://app.webinar.net *.clickmeeting.com https://vimeo.com https://player.vimeo.com"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"957\",\n \"promotion_code\": \"BookingV1\",\n \"name\": \"100% Discount\",\n \"event_code\": \"{{eventCode}}\",\n \"start_date\": \"2025-10-09\",\n \"start_time\": \"00:00:00\",\n \"expiry_date\": \"2025-10-30\",\n \"expiry_time\": \"23:59:00\",\n \"is_active\": true,\n \"amount\": 0,\n \"percent\": 100,\n \"discount_type\": \"percent\",\n \"is_per_ticket_discount\": false,\n \"purchase_minimum\": 1,\n \"custom_fields\": [\n {\n \"code\": \"CFDR8NAYI8TQYR9XXH4\",\n \"name\": \"required_field\",\n \"type\": \"TEXT\",\n \"label\": \"Required Field\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n },\n {\n \"code\": \"CFDDJJ7AISWK2V4IOO9\",\n \"name\": \"namely\",\n \"type\": \"TEXT\",\n \"label\": \"name\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ],\n \"minimum_ticket_threshold\": null,\n \"maximum_ticket_threshold\": null,\n \"maximum_application\": 1,\n \"tickets_connected\": [\n {\n \"code\": \"TIC15Z7JSPA\",\n \"name\": \"Sample Ticket\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"56a6d318-0e3d-4803-b46f-e77977621f89"},{"name":"Get Single Promotion","event":[{"listen":"test","script":{"id":"979b62ae-6259-4395-b113-aa85a603f9d7","exec":["pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.equal(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"registrationPromotionFields\"));","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c3ff4055-fa12-4de9-b6f7-9f44f569a0e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/registrations/promotions//","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","registrations","promotions","",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"17cb88c5-a7c1-446e-a188-ec6511106441","name":"Get Single Promotion","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/registrations/promotions//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Thu, 30 Oct 2025 16:46:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"636"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"957\",\n \"promotion_code\": \"BookingV1\",\n \"name\": \"100% Discount\",\n \"event_code\": \"{{eventCode}}\",\n \"start_date\": \"2025-10-09\",\n \"start_time\": \"00:00:00\",\n \"expiry_date\": \"2025-10-30\",\n \"expiry_time\": \"23:59:00\",\n \"is_active\": true,\n \"amount\": 0,\n \"percent\": 100,\n \"discount_type\": \"percent\",\n \"is_per_ticket_discount\": false,\n \"purchase_minimum\": 1,\n \"custom_fields\": [\n {\n \"code\": \"CFDR8NAYI8TQYR9XXH4\",\n \"name\": \"required_field\",\n \"type\": \"TEXT\",\n \"label\": \"Required Field\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n },\n {\n \"code\": \"CFDDJJ7AISWK2V4IOO9\",\n \"name\": \"namely\",\n \"type\": \"TEXT\",\n \"label\": \"name\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ],\n \"minimum_ticket_threshold\": null,\n \"maximum_ticket_threshold\": null,\n \"maximum_application\": 1,\n \"tickets_connected\": [\n {\n \"code\": \"TIC15Z7JSPA\",\n \"name\": \"Sample Ticket\"\n }\n ]\n}"}],"_postman_id":"c3ff4055-fa12-4de9-b6f7-9f44f569a0e9"}],"id":"5bdf934f-8213-47cf-bd66-1e43a4344d70","description":"A Registration Promotion in PheedLoop is used to offer attendees discounts, either as a percentage or a fixed monetary amount.
\nRegistration Promotion are accessible from the Dashboard under your chosen Event -> Registration -> Promotions.
\n","event":[{"listen":"prerequest","script":{"id":"66dcdf0a-5e1f-4e28-8671-2e3740b56166","type":"text/javascript","packages":{},"requests":{},"exec":["pm.collectionVariables.set(\"registrationPromotionFields\", "," ["," \"code\","," \"name\","," \"promotion_code\","," \"event_code\","," \"start_time\","," \"start_date\","," \"expiry_date\","," \"expiry_time\","," \"is_active\","," \"discount_type\","," \"amount\","," \"percent\","," \"is_per_ticket_discount\","," \"purchase_minimum\","," \"minimum_ticket_threshold\","," \"maximum_ticket_threshold\","," \"maximum_application\","," \"custom_fields\","," \"tickets_connected\","," \"date_updated\""," ]",");"]}},{"listen":"test","script":{"id":"5b618e3c-41ed-4bbe-8ef1-0d882ce72ee3","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"5bdf934f-8213-47cf-bd66-1e43a4344d70"},{"name":"Sessions","item":[{"name":"Create Session","event":[{"listen":"test","script":{"id":"36ceab17-01bb-4eaf-bf66-feba1742e227","exec":["pm.test(\"Status code is 201\", function () {"," pm.expect(pm.response.code).to.be.equal(201);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sessionFields\"));","});","","pm.collectionVariables.set(\"sessionCode\", pm.response.json().code);",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"f16eaf28-50d2-4d1b-9e29-974f98ddcb94","exec":[""],"type":"text/javascript","packages":{}}}],"id":"33cf1224-b4e2-4b40-8a8d-69fd04657c6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Marinated for 24 hours\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"SESSION-LOCATION-TITLE\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"speakers\": [\n \"{{speakerCodePersistent}}\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"audiences\": [\n \"{{sessionAudienceNamePersistent}}\"\n ],\n \"tags_restrict\": [\n \"TAG-CODE\"\n ],\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"tracks\": [\n \"{{sessionTrackName}}\"\n ],\n \"credit_value\": 0.0,\n \"authors\": \"\",\n \"is_channel\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/","description":"Creates a new Session for your specified Event.
\nThere are a few rules regarding the date and time fields:
\nstart_time and end_time if you do not wish to assign a time to your Session)To assign Tracks or Target Audiences to a Session, provide an array of strings, each string equalling a Target Audience's title. The Audience must already exist and be a valid title in order to be assigned.
\nLocations can be assigned if they are already created from the Dashboard. When POSTing or PATCHing Session Locations, pass a string that is the title of the Session Location you wish to assign.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"980f31ba-8e6e-4de3-b67b-1dd8000a32b1","name":"Create Session","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"The Great Wing\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"SESSION-LOCATION-TITLE\",\n \"sponsors\": [\n \"SPTIQ9WSEZ5UMQJ9B2\"\n ],\n \"internal_code\": \"\",\n \"speakers\": [\n \"{{speakerCodePersistent}}\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"audiences\": [\n \"{{sessionAudienceNamePersistent}}\"\n ],\n \"tags_restrict\": [\n \"TAG-CODE\"\n ],\n \"formats\": [\n Test Format\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"is_channel\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 03 Jun 2022 16:24:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"439"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SESSION-CODE\",\n \"event\": \"{{eventCode}}\",\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Marinated for 24 hours\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"Conference Room A\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"internal_code\": null,\n \"speakers\": [\n \"SPEAKER-CODE\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"tracks\": [],\n \"audiences\": [\n \"{{sessionAudienceNamePersistent}}\"\n ],\n \"tags_restrict\": [\n \"TAGBWK2QRG2\"\n ],\n \"authors\": \"\",\n \"is_channel\": false\n}"}],"_postman_id":"33cf1224-b4e2-4b40-8a8d-69fd04657c6f"},{"name":"List Sessions","event":[{"listen":"test","script":{"id":"d8875378-dc0d-4edd-bc4d-dbbe656c44bb","exec":["pm.test('Status code is 200', function () {"," pm.response.to.have.status(200);","})","","pm.test(\"All excepted fields are returned in each list item\", function () {"," const allFields = pm.collectionVariables.get(\"sessionFields\");"," allFields.push(\"id\");"," pm.expect(pm.response.json()[\"results\"][0]).to.have.all.keys(allFields);","});","",""],"type":"text/javascript"}}],"id":"dad12bdd-06d2-46f5-bc49-dde5132c48a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/","description":"Returns a list of Sessions for your specified Event.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?title=another will return Sessions that are called Another Session.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"786f70fb-027a-4bbe-9e6a-a17e461a282b","name":"List Sessions","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/?page=1&page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions",""],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 03 Jun 2022 16:05:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"598"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": \"{{baseUrl}}/api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"ANNOUNCEMENT-CODE\",\n \"event\": \"{{eventCode}}\",\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Just in case you get left behind\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"Conference Room A\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"internal_code\": null,\n \"speakers\": [\n \"SPEAKER-CODE\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"tracks\": [\n \"My First Track\"\n ],\n \"audiences\": [\n \"Business\",\n \"Developers\"\n ],\n \"tags_restrict\": [\n \"TAGBWK2QRG2\"\n ],\n \"authors\": \"\",\n \"is_channel\": false\n }\n ]\n}"},{"id":"dfca037b-cfe6-4661-afe7-d6db949cc52f","name":"Search Sessions","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/?title=Great","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions",""],"query":[{"key":"title","value":"Great"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 03 Jun 2022 16:04:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"490"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SESSION-CODE\",\n \"event\": \"{{eventCode}}\",\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Just in case you get left behind\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"Conference Room A\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"internal_code\": null,\n \"speakers\": [\n \"SPEAKER-CODE\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"tracks\": [\n \"My First Track\"\n ],\n \"audiences\": [\n \"Business\",\n \"Developers\"\n ],\n \"tags_restrict\": [\n \"TAGBWK2QRG2\"\n ],\n \"authors\": \"\",\n \"is_channel\": false\n }\n ]\n}"}],"_postman_id":"dad12bdd-06d2-46f5-bc49-dde5132c48a0"},{"name":"Get Single Session","event":[{"listen":"test","script":{"id":"5b3d8c31-1dc7-4244-917d-e0f9a2c8c03e","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sessionFields\"));","});"],"type":"text/javascript"}}],"id":"0a83664e-97a0-4513-bf82-a00477501616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/","description":"Gets a single Session for an Event, based on the Session Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","SESSION-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"e49a24fb-feaa-4fc1-955e-dfe615a0225a","name":"Get Single Session","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 03 Jun 2022 15:58:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"443"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SESSION-CODE\",\n \"event\": \"{{eventCode}}\",\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Just in case you get left behind\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"Conference Room A\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"internal_code\": null,\n \"speakers\": [\n \"SPEAKER-CODE\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"tracks\": [],\n \"audiences\": [\n \"Develoeprs\"\n ],\n \"tags_restrict\": [\n \"TAGBWK2QRG2\"\n ],\n \"authors\": \"\",\n \"is_channel\": false\n}"}],"_postman_id":"0a83664e-97a0-4513-bf82-a00477501616"},{"name":"Update Session","event":[{"listen":"test","script":{"id":"edc35e88-125b-44e6-b5c2-e3f4984642c3","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sessionFields\"));","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"02291007-c969-4d5f-8f25-c58fef919000","exec":["postman.setNextRequest(\"Add Session Attendees\")"],"type":"text/javascript","packages":{}}}],"id":"99b4573a-ccdc-403c-8397-df22886dfd14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Marinated for 48 hours\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"SESSION-LOCATION-TITLE\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"speakers\": [\n \"{{speakerCodePersistent}}\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"audiences\": [\n \"{{sessionAudienceNamePersistent}}\"\n ],\n \"tags_restrict\": [\n \"TAG-CODE\"\n ],\n \"formats\": [\n \"Test Format, Test Format2\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4, SES0L1X7KK5R5DGAB\"\n ],\n \"tracks\": [\n \"{{sessionTrackName}}\"\n ],\n \"is_channel\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/","description":"Update a single Session, based on their code. Note the same rules for POSTing apply here as well (see Create Session for more information).
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","SESSION-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"07995870-633d-4128-bde9-e37b32659320","name":"Update Session","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Marinated for 48 hours\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"SESSION-LOCATION-TITLE\",\n \"speakers\": [\n \"{{speakerCodePersistent}}\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"audiences\": [\n \"{{sessionAudienceNamePersistent}}\"\n ],\n \"internal_code\": \"\",\n \"tags_restrict\": [\n \"TAG-CODE\"\n ],\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SESMU66IH4HQ40IK3\"\n ],\n \"authors\": \"\",\n \"is_channel\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 03 Jun 2022 16:17:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"443"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SESSION-CODE\",\n \"event\": \"{{eventCode}}\",\n \"formats\": [\n \"Test Format\"\n ],\n \"sub_sessions\": [\n \"SES160BYRC13RHLX4\"\n ],\n \"title\": \"The Great Wing\",\n \"sub_title\": \"Marinated for 48 hours\",\n \"about\": \"Come learn about the great Wing of the 1920s!\",\n \"location\": \"Conference Room A\",\n \"sponsors\": [\n \"{{sponsorPersistent}}\"\n ],\n \"internal_code\": null,\n \"speakers\": [\n \"SPEAKER-CODE\"\n ],\n \"instructions\": \"Follow your stomach!\",\n \"session_date\": \"2021-11-22\",\n \"start_time\": \"12:00:00\",\n \"end_time\": \"13:30:00\",\n \"tracks\": [\n \"My First Track\"\n ],\n \"audiences\": [\n \"{{sessionAudienceNamePersistent}}\"\n ],\n \"tags_restrict\": [\n \"TAGBWK2QRG2\"\n ],\n \"authors\": \"\",\n \"is_channel\": false\n}"}],"_postman_id":"99b4573a-ccdc-403c-8397-df22886dfd14"},{"name":"Delete Session","event":[{"listen":"test","script":{"id":"5205b308-1b22-48ae-ab71-de811898b16e","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e1146901-7e86-4aeb-939d-d55fb76983b7","exec":["postman.setNextRequest(\"Create Session Format\")"],"type":"text/javascript"}}],"id":"859c0468-12cc-4132-b1f4-82d30fa5cf6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/","description":"Deletes a single Session from your specific event. A 204 will be returned on successful deletion.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","SESSION-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"b4c671ba-2ea4-4b9d-911d-330d80e32ed1","name":"Delete Session","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 03 Jun 2022 19:27:10 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"859c0468-12cc-4132-b1f4-82d30fa5cf6d"}],"id":"569dab55-20af-4022-9cac-d68c198d0914","description":"A Session in PheedLoop is a mini event during your event that is presented by a Speaker (or Speakers) to your Attendees. Sessions are specific to events, but for convenience we do have some Organization wide endpoints.
\nSessions can be viewed from the dashboard under the All Events -> Sessions -> Sessions section. You may created, edit, and delete Sessions via this menu, as well as this API.
\nSeveral endpoints are available for getting and updating Sessions within the PheedLoop system. All of the Session endpoints require an organizationCode in their URL and event specific endpoints require an event_code in their URL.
Note that all endpoints below are assumed to be an Event endpoint unless stated with Organization Wide.
Registers multiple attendees into a specific session. The sessionCode is provided as part of the URL path. In the request body, supply a list of attendee codes that should be registered for that session.
Retrieves the list of all attendees registered for a specific session identified by sessionCode.
Overwrites all existing attendee registrations for a specific session with the provided list of attendee codes. After this operation, only the attendees in the request body will remain registered.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","SESSION-CODE","attendance",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"b7239990-9d30-4f02-8a98-a61509579db8","name":"Bulk Add Attendee","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"codes\": [{{attendeeList}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/attendance/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 00:17:04 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"143"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SESE3A9E7XNETJ77G\",\n \"title\": \"How to start a business 101\",\n \"attendance\": [\n \"ATT7TO1YJPLI2JEYY1Q57NTU6DFL\",\n \"ATTE2OOK3PFO9XH1YOLMP2MBREDB\"\n ]\n}"}],"_postman_id":"b1a6fc3d-7fb8-41c3-bfcf-dae5bbfaf283"},{"name":"Bulk Session Registration","event":[{"listen":"test","script":{"id":"513628fd-6211-46dc-a6e5-4a8e79a273be","exec":["pm.test('Test remove attendance response status 204', function () {"," pm.expect(pm.response.code).to.equal(204);","})",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f41f0ba1-a78b-4973-9a74-723491a889ef","exec":["postman.setNextRequest(\"Delete Session\")"],"type":"text/javascript"}}],"id":"0989425c-74bd-4b69-9d48-0827816383f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"codes\": [\"\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/SESSION-CODE/attendance/","description":"Removes one or more attendees from a session, identified by sessionCode. Provide a list of attendee codes to be removed in the request body.
The Session Registration API enables users to manage attendee registration for specific session.
\nSession Registration can be viewed on the dashboard under the All Events -> Sessions -> Select a specific session and click the action button you will see a View Registrations option. You may view, add, and remove Registrations via this menu, as well as this API.
\n","_postman_id":"a595b67b-846c-43a1-996f-f26ccde11d15"},{"name":"Session Formats","item":[{"name":"Create Session Format","event":[{"listen":"test","script":{"id":"3ba4b388-b906-45e9-9bbd-710f3c03eb19","exec":["pm.test(\"Status code is 201\", function () {"," pm.expect(pm.response.code).to.be.equal(201);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sessionFormat\"));","});","","pm.collectionVariables.set(\"formatCode\", pm.response.json().code);",""],"type":"text/javascript"}}],"id":"bc907614-0e95-45e7-bc33-1fcb42d46459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Session Format\",\n \"color\": \"#007bff\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"ee0d251a-a061-419c-8dc1-746f8adcae8d","name":"Create Session Format","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Session Format\",\n \"color\": \"#007bff\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 10 Apr 2023 13:54:48 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"104"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"{{eventCode}}\",\n \"code\": \"Test Format\",\n \"title\": \"Session Format\",\n \"color\": \"#007bff\"\n}"}],"_postman_id":"bc907614-0e95-45e7-bc33-1fcb42d46459"},{"name":"List Session Formats","event":[{"listen":"test","script":{"id":"788bb532-6aa3-4ac5-b39b-ff429d017417","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[\"results\"][0]).to.have.all.keys(pm.collectionVariables.get(\"sessionFormat\"));","});"],"type":"text/javascript"}}],"id":"fb2f0c3f-917d-4e40-a91c-5895898cbfae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"a9d56913-a66a-4d6a-bd6d-01547501ec9c","name":"List Session Formats","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/?page=1&page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats",""],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 10 Apr 2023 13:57:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"969"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"event\": \"{{eventCode}}\",\n \"code\": \"Test Format\",\n \"title\": \"Session Format\",\n \"color\": \"#007bff\"\n }\n ]\n}"},{"id":"89d99619-75d3-4394-8a6f-c966688d08a5","name":"Search Session Formats","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/?title=Format","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats",""],"query":[{"key":"title","value":"Format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 10 Apr 2023 13:57:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"969"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"event\": \"{{eventCode}}\",\n \"code\": \"Test Format\",\n \"title\": \"Session Format\",\n \"color\": \"#007bff\"\n }\n ]\n}"}],"_postman_id":"fb2f0c3f-917d-4e40-a91c-5895898cbfae"},{"name":"Get Single Session Format","event":[{"listen":"test","script":{"id":"1eedd419-de41-4c11-a959-eeb5f1f2f1b1","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sessionFormat\"));","});"],"type":"text/javascript"}}],"id":"9f5d824f-5082-4611-806b-9c4c1d0bea75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/Test Format/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats","Test Format",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"104be9e8-9d18-4c76-b8d2-1cc06546bec5","name":"Get Single Session Format","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/Test Format/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 10 Apr 2023 14:14:14 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"104"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"{{eventCode}}\",\n \"code\": \"Test Format\",\n \"title\": \"Session Format\",\n \"color\": \"#007bff\"\n}"}],"_postman_id":"9f5d824f-5082-4611-806b-9c4c1d0bea75"},{"name":"Update Session Format","event":[{"listen":"test","script":{"id":"0222efcf-11fa-4f67-9b34-0a9d778a0b9d","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sessionFormat\"));","});",""],"type":"text/javascript"}}],"id":"2ffe4a5f-dc54-42f4-947e-9e6a45f4eab9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Updated Session Format\",\n \"color\": \"#007bff\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/Test Format/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats","Test Format",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"e5088178-c719-49b3-838f-f86a2a9aa529","name":"Update Session Format","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Updated Session Format\",\n \"color\": \"#007bff\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/Test Format/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 10 Apr 2023 14:14:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"112"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"{{eventCode}}\",\n \"code\": \"Test Format\",\n \"title\": \"Updated Session Format\",\n \"color\": \"#007bff\"\n}"}],"_postman_id":"2ffe4a5f-dc54-42f4-947e-9e6a45f4eab9"},{"name":"Delete Session Format","event":[{"listen":"test","script":{"id":"cd9d1b5c-b483-4385-a636-dec07c9513e7","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});"],"type":"text/javascript"}}],"id":"e65f203d-a5d4-4738-911d-3e897047a42c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/Test Format/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sessions","formats","Test Format",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"64894426-8878-4a19-a447-7c864cd51f99","name":"Delete Session Format","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sessions/formats/Test Format/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 10 Apr 2023 14:15:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e65f203d-a5d4-4738-911d-3e897047a42c"}],"id":"09ada8de-7e84-4193-809a-efd91351f3c4","description":"A Session Format in PheedLoop is similar to attendee tags, but for Sessions. Session Formats are specific to events.
\nIf you do not have multiple formats at your event, you can ignore this API entirely.
\nSession Format can be viewed from the dashboard under All Events -> Session -> Sessions sections. Click to view or create a new Session -> Under Other Details -> Formats -> Manage. You may create, updat and delete Session Formats via this menu, as well as this API.
\nSeveral endpoints are available for getting and updated Session Formats within PheedLoop system. All of the Session Format endpoints required both organizationCode and eventCode in their URL.
Note that all endpoints below are assumed to be an Event Wide endpoint.
Creates a new Exhibitor for your specified Event.
\nRelated fields such as managers, contact_primary, and contact_secondary accept either a list of strings or a single string with the Attendee code. The Attendee code can be retrieved from either the Attendee List or Member List endpoints. You may also convert an Attendee/Member email to a code via this endpoint.
To assign Products/Services to an Exhibitor, provide an array of strings, each string equalling a Product/Service's name. The Product/Service must already exist and be a valid name in order to be assigned.
\nIf you would like to provide images for your Exhibitor (logo, banner, thumbnail), please make the request with multipart/form-data as the Content-Type in the header. As form data does not support nested relationships, you may see unexpected results when trying to POST Managers with form data. If you are not using images, we recommend staying with application/json as the Content-Type.
Please see the example listed with (With Images) for more information.
Returns a list of Exhibitors for your specified Event.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?name=another will return Exhibitors that are called Another Exhibitor.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"a287c51b-4b3c-45a4-a9d1-0134c2e80e30","name":"List Exhibitors","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/?page=2&page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors",""],"query":[{"key":"page","value":"2"},{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:07:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 24,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/?page=3&page_size=1\",\n \"previous\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/?page_size=1\",\n \"results\": [\n {\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATT78R1XO2QRAMU78GHBJIFL9YEP\",\n \"ATTYNP1N8EDSYKSXVVLSNDE17VOD\"\n ],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTVNHI8PEDT9SB5IQP1KY4T8V4C\",\n \"contact_secondary\": \"ATTKZJDV1A5ETCC4DPF1MR8B16QE\",\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [\n \"{{ExhibitorProductServicePersistent}}\"\n ],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n }\n ]\n}"},{"id":"2b9754b0-bf0b-403a-b5ac-fa43d9cad487","name":"Search Exhibitors","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/?name=Spicy","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors",""],"query":[{"key":"name","value":"Spicy"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:07:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATT78R1XO2QRAMU78GHBJIFL9YEP\",\n \"ATTYNP1N8EDSYKSXVVLSNDE17VOD\"\n ],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTVNHI8PEDT9SB5IQP1KY4T8V4C\",\n \"contact_secondary\": \"ATTKZJDV1A5ETCC4DPF1MR8B16QE\",\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [\n \"{{ExhibitorProductServicePersistent}}\"\n ],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n }\n ]\n}"}],"_postman_id":"7168a64d-d2b1-42e1-9dfc-c3097be39e24"},{"name":"Get Single Exhibitor","event":[{"listen":"test","script":{"id":"119a9977-42d5-4539-bc3d-85a70430e70c","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"exhibitorFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"0db88312-f492-4104-b3b5-c839ef858d9b","exec":[""],"type":"text/javascript"}}],"id":"4e8dd64b-8678-4d9b-814f-a313b264bbd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/","description":"Gets a single Exhibitor for an Event, based on the Exhibitor Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors","EXHIBITOR-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"1bd90fa0-3048-414e-ba9b-39522ccfaba3","name":"Get Single Exhibitor","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Dec 2021 19:32:50 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATT78R1XO2QRAMU78GHBJIFL9YEP\",\n \"ATTYNP1N8EDSYKSXVVLSNDE17VOD\"\n ],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTVNHI8PEDT9SB5IQP1KY4T8V4C\",\n \"contact_secondary\": \"ATTKZJDV1A5ETCC4DPF1MR8B16QE\",\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [\n \"{{ExhibitorProductServicePersistent}}\"\n ],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}"}],"_postman_id":"4e8dd64b-8678-4d9b-814f-a313b264bbd8"},{"name":"Get Exhibitor Order Summary","event":[{"listen":"test","script":{"id":"35e98305-582d-4458-bdcd-fd9fedcac8e7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"exhibitorOrderFields\"));","});",""],"type":"text/javascript","packages":{}}}],"id":"f055c0d8-4a1d-4d1a-9cb8-f78f2d2c9577","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/order/summary/","description":"Gets the Exhibitor Order Summary for an Event, based on the Exhibitor Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors","EXHIBITOR-CODE","order","summary",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"7a5fd872-e783-4515-ab9e-7d6d2e7e30ca","name":"Get Exhibitor Order Summary","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Dec 2021 19:32:50 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"organization_code\": \"{{organizationCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"application_status\": \"Complete\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\",\n \"payment_summary\": {\n \"sub_total\": 100.05,\n \"total_tax\": 5.0,\n \"total_payment\": 205.0,\n \"total_refund\": 30.0,\n \"amount_due\": 0.0\n },\n \"primary_contact\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@doe.com\",\n \"title\": \"Engineer\",\n \"organization\": \"PheedLoop\",\n \"phone\": \"\",\n \"fax\": \"\"\n },\n \"purchases\": [\n {\n \"code\": \"PPRGJCFCAHV\",\n \"product_name\": \"Exhibitor Package\",\n \"is_redeemed\": false,\n \"custom_fields\": []\n }\n ],\n \"tickets\": [\n {\n \"code\": \"PURYP7WXWFM\",\n \"ticket_code\": \"TICB5TNQSDK\",\n \"ticket_name\": \"Exhibitor Ticket\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@doe.com\",\n \"title\": \"Engineer\",\n \"custom_fields\": [\n {\n \"code\": \"CFDG7J0HL4W107BTLH7\",\n \"name\": \"productcode\",\n \"label\": \"Product Code\",\n \"value\": \"\"\n },\n {\n \"code\": \"CFDAL9V61IGJSQBPHZB\",\n \"name\": \"glcode\",\n \"label\": \"GL Code\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"code\": \"PAY0G7YNRNP\",\n \"payment_id\": \"10000127\",\n \"amount\": 105.0,\n \"fees\": 0.0,\n \"tax\": 5.0,\n \"is_verified\": true,\n \"date_created\": \"2024-03-07 21:46:07\",\n \"method\": \"CCARD\",\n \"gateway\": \"STRIPE\"\n },\n {\n \"code\": \"PAYURZ7JHYB\",\n \"payment_id\": \"ch_1234.......\",\n \"amount\": 100.0,\n \"fees\": 0.0,\n \"tax\": 0.0,\n \"is_verified\": true,\n \"date_created\": \"2024-05-31 19:45:35\",\n \"method\": \"CCARD\",\n \"gateway\": \"STRIPE\"\n }\n ],\n \"refunds\": [\n {\n \"code\": \"REF8MTEJPI7\",\n \"payment_code\": \"PAYURZ7JHYB\",\n \"amount\": 10.0,\n \"refund_id\": \"re_3PMbdjIDcZnBrdux1hdq4IfV\",\n \"date_created\": \"2024-05-31 20:27:14\",\n \"method\": \"CCARD\",\n \"gateway\": \"STRIPE\"\n }\n ],\n \"discounts\": [\n {\n \"code\": \"PDS8B5XESJT\",\n \"promotion_name\": \"Early Bird\",\n \"amount\": 10.0,\n \"date_applied\": \"2025-02-06 17:05:41\",\n \"custom_fields\": [\n {\n \"code\": \"CFDB9UIZ60YZYEL4JQ8\",\n \"name\": \"exhibitor_gl_code\",\n \"label\": \"Exhibitor GL Code\",\n \"value\": \"123789\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"f055c0d8-4a1d-4d1a-9cb8-f78f2d2c9577"},{"name":"Update Exhibitor","event":[{"listen":"test","script":{"id":"4b0012a5-6d32-488a-ad74-0340f9fb2fdc","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"exhibitorFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e8c61c88-8f67-4862-b7d3-d705943a9ad0","exec":[""],"type":"text/javascript"}}],"id":"70e1a861-2b2d-45f1-9462-05de62aaa04f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\"\n ],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [\n \"{{ExhibitorProductServicePersistent}}\"\n ],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/","description":"Update a single Exhibitor, based on their code. Note the same rules described in the POST apply here as well (see Create Exhibitor for more information).
\nTo remove a Contact, send the field with an empty string. To remove all Managers, send an empty array.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors","EXHIBITOR-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"15807580-a996-4bf2-abe7-dc22130deab6","name":"Update Exhibitor","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATT78R1XO2QRAMU78GHBJIFL9YEP\",\n \"ATTYNP1N8EDSYKSXVVLSNDE17VOD\"\n ],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTVNHI8PEDT9SB5IQP1KY4T8V4C\",\n \"contact_secondary\": \"ATTKZJDV1A5ETCC4DPF1MR8B16QE\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [\n \"{{ExhibitorProductServicePersistent}}\"\n ],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 20:02:11 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATT78R1XO2QRAMU78GHBJIFL9YEP\",\n \"ATTYNP1N8EDSYKSXVVLSNDE17VOD\"\n ],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTVNHI8PEDT9SB5IQP1KY4T8V4C\",\n \"contact_secondary\": \"ATTKZJDV1A5ETCC4DPF1MR8B16QE\",\n \"logo\": \"\",\n \"banner\": \"\",\n \"thumbnail\": \"\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [\n \"{{ExhibitorProductServicePersistent}}\"\n ],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_country\": \"United States\",\n \"address_zip\": \"94111\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}"},{"id":"1cb948ca-66a9-408d-9cf3-a9b0e8421a5a","name":"Update Exhibitor (With Images)","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Spicy Wing Sauce","type":"text"},{"key":"tagline","value":"This Is Some Spicy Sauce!","type":"text"},{"key":"code_internal","value":"123456","type":"text"},{"key":"description","value":"Our spicy sauce will make you gasp for water it's really hot!","type":"text"},{"key":"contact_primary","value":"ATTWFKEQ75Q9D68SYNO333VZ0TG8","type":"text"},{"key":"contact_secondary","value":"ATTQBVOKK11V4V6V7Z3YHOBU78F3","type":"text"},{"key":"email","value":"info@spicywingsauce.com","type":"text"},{"key":"website","value":"https://spicywingsauce.com","type":"text"},{"key":"twitter","value":"https://twitter.com/spicywingsauce","type":"text"},{"key":"youtube","value":"https://youtube.com/spicywingsauce","type":"text"},{"key":"facebook","value":"https://facebook.com/spicywingsauce","type":"text"},{"key":"linkedin","value":"https://linkedin.com/spicywingsauce","type":"text"},{"key":"instagram","value":"https://instagram.com/spicywingsauce","type":"text"},{"key":"address_line_1","value":"1 Ferry Building","type":"text"},{"key":"address_line_2","value":"Suite 200","type":"text"},{"key":"address_city","value":"San Francisco","type":"text"},{"key":"address_state","value":"CA","type":"text"},{"key":"address_zip","value":"94111","type":"text"},{"key":"address_country","value":"United States","type":"text"},{"key":"address_phone","value":"14155708871","type":"text"},{"key":"address_phone_work","value":"14155708871","type":"text"},{"key":"address_phone_mobile","value":"14155708872","type":"text"},{"key":"logo","type":"file","src":"PheedLoop API Testing/images/windows.jpg"},{"key":"banner","type":"file","src":"PheedLoop API Testing/images/windows.jpg"},{"key":"thumbnail","type":"file","src":"PheedLoop API Testing/images/windows.jpg"}],"options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 15 Dec 2021 21:07:13 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water it's really hot!\",\n \"managers\": [],\n \"booths\": [\n \"EXHBOTKJJHEXGYIX8EZ7\"\n ],\n \"default_booth_area\": 10,\n \"contact_primary\": \"ATTKRTKFYPPS57ADYK9017VMOKDT\",\n \"contact_secondary\": \"ATT1YVWCYYZ9IJAQOOD4ZMPR7UJ5\",\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXH6P1061ZQUIFV2J/937335.jpg\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXH6P1061ZQUIFV2J/946631.jpg\",\n \"thumbnail\": \"{{baseURL}}media/events/{[eventCode]}/exhibitors/EXH6P1061ZQUIFV2J/120471.jpg\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_country\": \"United States\",\n \"address_zip\": \"94111\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}"}],"_postman_id":"70e1a861-2b2d-45f1-9462-05de62aaa04f"},{"name":"Delete Exhibitor","event":[{"listen":"test","script":{"id":"63457d6a-7fc2-4c1e-83c1-09f8f0d175d0","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"996a64ba-5eea-4234-833f-9d6a2b3ea6e1","exec":[""],"type":"text/javascript"}}],"id":"f8a8bbb0-8531-45be-aece-9178d9fc0a2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/","description":"Deletes a single Exhibitor from your specific event. A 200 will be returned on successful deletion along with the contents of the deleted Exhibitor.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","exhibitors","EXHIBITOR-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2c090550-9435-48e8-b8be-4acf25598434","name":"Delete Exhibitor","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 20:09:26 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"EXHIBITOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"managers\": [\n \"ATT78R1XO2QRAMU78GHBJIFL9YEP\",\n \"ATTYNP1N8EDSYKSXVVLSNDE17VOD\"\n ],\n \"contact_primary\": \"ATTVNHI8PEDT9SB5IQP1KY4T8V4C\",\n \"contact_secondary\": \"ATTKZJDV1A5ETCC4DPF1MR8B16QE\",\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/exhibitors/EXHIBITOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"product_services\": [],\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}"}],"_postman_id":"f8a8bbb0-8531-45be-aece-9178d9fc0a2b"}],"id":"ea12f03b-734f-482c-83d6-c9f5d623402d","description":"An Exhibitor in PheedLoop is a company or person exhibiting at your event. They typically have an exhibitor booth and some times are linked to a Sponsor. Exhibitors are specific to events, but for convenience we do have some Organization wide endpoints.
\nExhibitors can be viewed from the dashboard under the All Events -> Exhibitors -> Exhibitors section. You may created, edit, and delete Exhibitors via this menu, as well as this API.
\nSeveral endpoints are available for getting and updating Exhibitors within the PheedLoop system. All of the Exhibitor endpoints require an organizationCode in their URL and event specific endpoints require an event_code in their URL.
Note that all endpoints below are assumed to be an Event endpoint unless stated with Organization Wide.
Exhibitor Booths in PheedLoop are used for Exhibitors within your event. Exhibitor Booth are specific to events.
\nThis collection of endpoints currently do not support Organization wide endpoints.
\nExhibitors can be assigned booths, and booths can be used with Event Maps, and Exhibitor Floorplans.
\nExhibitor Booths can be viewed from the dashboard under the All Events -> Exhibitors -> Booths section. You may create, edit, and delete Exhibitor Booths via this menu, as well as this API.
\nSeveral endpoints are available for getting and updating Exhibitor Booths within the PheedLoop system. All of the Exhibitor Booths endpoints require both organizationCode and eventCode in their URL.
Note that all endpoints below are assumed to be an Event Wide endpoint.
Creates a new Sponsor for your specified Event.
\nRelated fields such as contact_primary and contact_secondary accept either a list of strings or a single string with the Attendee code. The Attendee code can be retrieved from either the Attendee List or Member List endpoints. You may also convert an Attendee/Member email to a code via this endpoint.
If you would like to provide images for your Exhibitor (logo, banner, thumbnail), please make the request with multipart/form-data as the Content-Type in the header. If you are not using images, we recommend staying with application/json as the Content-Type.
Please see the example listed with (With Images) for more information.
Returns a list of Sponsors for your specified Event.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?name=another will return Sponsors that are called Another Sponsors.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"a92107f8-3eb0-46ee-a49c-887b64d4ecb3","name":"List Sponsors","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/?page=2&page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors",""],"query":[{"key":"page","value":"2"},{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:07:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 24,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/?page=3&page_size=1\",\n \"previous\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/?page_size=1\",\n \"results\": [\n {\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"tiers\": [\n \"SPTIJRJANATQNZ5AC7\"\n ],\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n }\n ]\n}"},{"id":"321cb5f6-5e23-4c1e-853c-a217410a33c8","name":"Search Sponsors","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/?name=Spicy","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors",""],"query":[{"key":"name","value":"Spicy"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:07:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"tiers\": [\n \"SPTIJRJANATQNZ5AC7\"\n ],\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n }\n ]\n}"}],"_postman_id":"ae4a378b-f42a-4967-9112-f6459659551c"},{"name":"Get Single Sponsor","event":[{"listen":"test","script":{"id":"dbda6980-efba-4809-9e34-63c1c241c27a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sponsorFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c36929e5-1676-432c-9bd6-51ba9d7a0bb2","exec":[""],"type":"text/javascript"}}],"id":"6d12c938-f9c4-4f10-ac9b-60bf5ab84dd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/","description":"Gets a single Sponsor for an Event, based on the Sponsor Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","SPONSOR-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"d1b6b43f-4dce-4458-bec9-20447f28b3a6","name":"Get Single Sponsor","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Dec 2021 19:32:50 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"tiers\": [\n \"SPTIJRJANATQNZ5AC7\"\n ],\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}\n"}],"_postman_id":"6d12c938-f9c4-4f10-ac9b-60bf5ab84dd8"},{"name":"Get Sponsor Order Summary","event":[{"listen":"test","script":{"id":"dbda6980-efba-4809-9e34-63c1c241c27a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sponsorOrderFields\"));","});"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"c36929e5-1676-432c-9bd6-51ba9d7a0bb2","exec":[""],"type":"text/javascript","packages":{}}}],"id":"eefac2ab-944a-40a3-a7cd-53f5291c3227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/order/summary/","description":"Gets the Sponsor Order Summary for an Event, based on the Sponsor Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","SPONSOR-CODE","order","summary",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"574179cc-cc80-49c9-9322-12c98cb914f0","name":"Get Sponsor Order Summary","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Dec 2021 19:32:50 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"organization_code\": \"{{organizationCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"application_status\": \"Complete\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\",\n \"payment_summary\": {\n \"sub_total\": 50.05,\n \"total_tax\": 0.0,\n \"total_payment\": 1200.0,\n \"total_refund\": 0.0,\n \"amount_due\": 0.0\n },\n \"primary_contact\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@doe.com\",\n \"title\": \"Engineer\",\n \"organization\": \"PheedLoop\",\n \"phone\": \"555-123-1234\",\n \"fax\": \"\"\n },\n \"purchases\": [\n {\n \"code\": \"PPRS061XZ22\",\n \"product_name\": \"Gold Package\",\n \"is_redeemed\": false,\n \"custom_fields\": []\n }\n ],\n \"tickets\": [\n {\n \"code\": \"PUR84SUANXK\",\n \"ticket_code\": \"TICB5TNQSDK\",\n \"ticket_name\": \"Sponsor Ticket\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@doe.com\",\n \"title\": \"Engineer\",\n \"custom_fields\": [\n {\n \"code\": \"CFDG7J0HL4W107BTLH7\",\n \"name\": \"productcode\",\n \"label\": \"Product Code\",\n \"value\": \"\"\n },\n {\n \"code\": \"CFDAL9V61IGJSQBPHZB\",\n \"name\": \"glcode\",\n \"label\": \"GL Code\",\n \"value\": \"\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"code\": \"PAYSPB7LCWR\",\n \"payment_id\": \"1703107722jCgkJzFZshF7nQU\",\n \"amount\": 1100.0,\n \"fees\": 100.0,\n \"tax\": 100.0,\n \"is_verified\": true,\n \"date_created\": \"2023-12-20 21:28:51\",\n \"method\": \"CCARD\",\n \"gateway\": \"STRIPE\"\n }\n ],\n \"refunds\": [],\n \"discounts\": [\n {\n \"code\": \"PDSFBORLS8N\",\n \"promotion_name\": \"Early Bird\",\n \"amount\": 5.0,\n \"date_applied\": \"2025-02-07 16:14:50\",\n \"custom_fields\": []\n }\n ]\n}"}],"_postman_id":"eefac2ab-944a-40a3-a7cd-53f5291c3227"},{"name":"Update Sponsor","event":[{"listen":"test","script":{"id":"9ec5002d-5456-4d41-87f3-25f0434a87c6","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sponsorFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"09f321db-324c-4731-b599-51b07a115940","exec":[""],"type":"text/javascript"}}],"id":"2732c0b9-4c69-4e16-9055-388689b45a1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"tiers\": [\n \"SPTIQ9WSEZ5UMQJ9B2\"\n ],\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/","description":"Update a single Sponsor, based on their code. Note the same rules regarding Contacts and images apply here as well (see Create Sponsor for more information).
\nTo remove a Contact, send the field with an empty string.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","SPONSOR-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"9ca88cc0-2e37-41d1-87d6-d55932070018","name":"Update Sponsor","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"tiers\": [\n \"SPTIJRJANATQNZ5AC7\"\n ],\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 20:02:11 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"tiers\": [\n \"SPTIJRJANATQNZ5AC7\"\n ],\n \"logo\": \"\",\n \"banner\": \"\",\n \"thumbnail\": \"\",\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_country\": \"United States\",\n \"address_zip\": \"94111\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}"},{"id":"fcd59634-93a9-4b20-bb55-c2cf17777242","name":"Update Sponsor (With Images)","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Spicy Wing Sauce","type":"text"},{"key":"tagline","value":"This Is Some Spicy Sauce!","type":"text"},{"key":"code_internal","value":"123456","type":"text"},{"key":"description","value":"Our spicy sauce will make you gasp for water it's really hot!","type":"text"},{"key":"contact_primary","value":"ATTWFKEQ75Q9D68SYNO333VZ0TG8","type":"text"},{"key":"contact_secondary","value":"ATTQBVOKK11V4V6V7Z3YHOBU78F3","type":"text"},{"key":"email","value":"info@spicywingsauce.com","type":"text"},{"key":"website","value":"https://spicywingsauce.com","type":"text"},{"key":"twitter","value":"https://twitter.com/spicywingsauce","type":"text"},{"key":"youtube","value":"https://youtube.com/spicywingsauce","type":"text"},{"key":"facebook","value":"https://facebook.com/spicywingsauce","type":"text"},{"key":"linkedin","value":"https://linkedin.com/spicywingsauce","type":"text"},{"key":"instagram","value":"https://instagram.com/spicywingsauce","type":"text"},{"key":"address_line_1","value":"1 Ferry Building","type":"text"},{"key":"address_line_2","value":"Suite 200","type":"text"},{"key":"address_city","value":"San Francisco","type":"text"},{"key":"address_state","value":"CA","type":"text"},{"key":"address_zip","value":"94111","type":"text"},{"key":"address_country","value":"United States","type":"text"},{"key":"address_phone","value":"14155708871","type":"text"},{"key":"address_phone_work","value":"14155708871","type":"text"},{"key":"address_phone_mobile","value":"14155708872","type":"text"},{"key":"logo","type":"file","src":"PheedLoop API Testing/images/windows.jpg"},{"key":"banner","type":"file","src":"PheedLoop API Testing/images/windows.jpg"},{"key":"thumbnail","type":"file","src":"PheedLoop API Testing/images/windows.jpg"}],"options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 15 Dec 2021 21:15:50 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water it's really hot!\",\n \"contact_primary\": \"ATTKRTKFYPPS57ADYK9017VMOKDT\",\n \"contact_secondary\": \"ATT1YVWCYYZ9IJAQOOD4ZMPR7UJ5\",\n \"tiers\": [\n \"SPTIJRJANATQNZ5AC7\"\n ],\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPOA9AMS9D5T391WU/292609_windows.jpg\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPOA9AMS9D5T391WU/297377_windows.jpg\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPOA9AMS9D5T391WU/503488_windows.jpg\",\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_country\": \"United States\",\n \"address_zip\": \"94111\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}"}],"_postman_id":"2732c0b9-4c69-4e16-9055-388689b45a1f"},{"name":"Delete Sponsor","event":[{"listen":"test","script":{"id":"3732146a-e997-40d0-96e1-759e2bf2a0ca","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(204);","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e14c1a5f-c9bf-4ef4-8514-f0e4e45dea7d","exec":[""],"type":"text/javascript"}}],"id":"e23fe20a-6d60-4c50-ae34-f837722dc4da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/","description":"Deletes a single Sponsor from your specific event. A 200 will be returned on successful deletion along with the contents of the deleted Sponsor.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","SPONSOR-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"ab9bddc2-4e9e-4fe9-a647-6595b2b48040","name":"Delete Sponsor","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/SPONSOR-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 20:09:26 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPONSOR-CODE\",\n \"event\": \"{{eventCode}}\",\n \"name\": \"Spicy Wing Sauce\",\n \"tagline\": \"This Is Some Spicy Sauce!\",\n \"code_internal\": \"123456\",\n \"description\": \"Our spicy sauce will make you gasp for water, it's really hot!\",\n \"contact_primary\": \"ATTWFKEQ75Q9D68SYNO333VZ0TG8\",\n \"contact_secondary\": \"ATTQBVOKK11V4V6V7Z3YHOBU78F3\",\n \"logo\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/659245.png\",\n \"banner\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/698245.png\",\n \"thumbnail\": \"{{baseURL}}media/events/{{eventCode}}/sponsors/SPONSOR-CODE/656335.png\",\n \"email\": \"info@spicywingsauce.com\",\n \"website\": \"https://spicywingsauce.com\",\n \"twitter\": \"https://twitter.com/spicywingsauce\",\n \"youtube\": \"https://youtube.com/spicywingsauce\",\n \"facebook\": \"https://facebook.com/spicywingsauce\",\n \"linkedin\": \"https://linkedin.com/spicywingsauce\",\n \"instagram\": \"https://instagram.com/spicywingsauce\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"address_phone_work\": \"14155708871\",\n \"address_phone_mobile\": \"14155708872\"\n}\n"}],"_postman_id":"e23fe20a-6d60-4c50-ae34-f837722dc4da"}],"id":"3e57450c-bc51-4abb-9496-1f2b3d7f1cd9","description":"A Sponsor in PheedLoop is a company or person that is sponsoring your event. They typically are advertised as a sponsor on promotional material and the event website, and some times are linked to a Exhibitor. Sponsors are specific to events, but for convenience we do have some Organization wide endpoints.
\nSponsors can be viewed from the dashboard under the All Events -> Sponsors -> Sponsors section. You may created, edit, and delete Sponsors via this menu, as well as this API.
\nSeveral endpoints are available for getting and updating Sponsors within the PheedLoop system. All of the Sponsor endpoints require an organizationCode in their URL and event specific endpoints require an event_code in their URL.
Note that all endpoints below are assumed to be an Event endpoint unless stated with Organization Wide.
Creates a new Speaker for your specified Event. Emails must be unique, and an error will be returned if you attempt to create a Speaker with an email that is already used for another Speaker in your Event.
\nNote that tags for Speakers are separate from the Tag endpoint that is used for Attendees and other parts of the platform. These tags are specific to Speakers and us such they do not supply codes. To assign Speaker Tags to a Speaker, provide an array of strings, each string equalling a Speaker Tag's title. The tag must already exist and be a valid title in order to be assigned.
\nTag names are case sensitive during POST/PATCHing.
\nIf you would like to provide images for your Speaker (picture and/or logo_company), please make the request with multipart/form-data as the Content-Type in the header. As form data does not support nested relationships, you may see unexpected results when trying to POST tags with form data. If you are not using images, we recommend staying with application/json as the Content-Type.
Please see the example listed with (With Images) for more information.
Returns a list of Speakers for your specified Event.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?first_name=Tim will return Speakers that are called Timothy.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"e0d88e00-7b85-42a7-82bf-a3476a665857","name":"List Speakers","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/?page=2&page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers",""],"query":[{"key":"page","value":"2"},{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:07:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 24,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/?page=3&page_size=1\",\n \"previous\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/?page_size=1\",\n \"results\": [\n {\n \"code\": \"SPEAKER-CODE\",\n \"event\": \"{{eventCode}}\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"designations\": \"He/Him\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [\n \"{{sessionCodePersistent}}\"\n ],\n \"tags\": [\n \"Speaker Tag\"\n ],\n \"picture\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_267511.png\",\n \"logo_company\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_311604.png\",\n \"code_internal\": \"CODE\"\n }\n ]\n}"},{"id":"130b7648-c37b-4c71-ac02-16bab3347385","name":"Search Speakers","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/?first_name=Tiim","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers",""],"query":[{"key":"first_name","value":"Tiim"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:07:02 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SPEAKER-CODE\",\n \"event\": \"{{eventCode}}\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"designations\": \"He/Him\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [\n \"{{sessionCodePersistent}}\"\n ],\n \"tags\": [\n \"Speaker Tag\"\n ],\n \"picture\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_267511.png\",\n \"logo_company\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_311604.png\",\n \"code_internal\": \"CODE\"\n }\n ]\n}"}],"_postman_id":"f4c71f5b-2678-4675-bb7d-aae07cb49941"},{"name":"Get Single Speaker","event":[{"listen":"test","script":{"id":"66a63e28-db4e-476e-b916-177ac6cefb06","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"speakerFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"11cf1995-73b2-4b93-872b-4789c42343d5","exec":[""],"type":"text/javascript"}}],"id":"274c2023-4eed-4093-bc49-6ce691d7ccb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/","description":"Gets a single Speakers for an Event, based on the Speakers Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","SPEAKER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"4e1ff644-bc06-4281-ab10-c9151fafda5a","name":"Get Single Speaker","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Dec 2021 19:32:50 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPEAKER-CODE\",\n \"event\": \"{{eventCode}}\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"designations\": \"He/Him\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [\n \"{{sessionCodePersistent}}\"\n ],\n \"tags\": [\n \"Speaker Tag\"\n ],\n \"picture\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_267511.png\",\n \"logo_company\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_311604.png\",\n \"code_internal\": \"CODE\"\n}"}],"_postman_id":"274c2023-4eed-4093-bc49-6ce691d7ccb6"},{"name":"Update Speaker","event":[{"listen":"test","script":{"id":"b5687505-7293-475b-a60c-3134e5dc888b","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"speakerFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"bdb33ca0-c868-4166-8f58-30fbab88d801","exec":[""],"type":"text/javascript"}}],"id":"68b6e07e-8ae7-4f0a-bbe1-784be6bdb774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [\n \"{{sessionCodePersistent}}\"\n ],\n \"tags\": [\n \"Speaker Tag\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/","description":"Update a single Speaker, based on their code. Note the same rules regarding Emails, Tags, and images apply here as well (see Create Speaker for more information).
\nTo remove a Tag, send the field with an empty string. To remove all Tags, send an empty array.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","SPEAKER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"795b7fd2-5b94-449c-afeb-83d273c37a2a","name":"Update Speaker","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [\n \"{{sessionCodePersistent}}\"\n ],\n \"tags\": [\n \"Speaker Tag\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 20:02:11 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPEAKER-CODE\",\n \"event\": \"{{eventCode}}\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"designations\": \"He/Him\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [\n \"{{sessionCodePersistent}}\"\n ],\n \"tags\": [\n \"Speaker Tag\"\n ],\n \"picture\": null,\n \"logo_company\": null,\n \"code_internal\": \"CODE\"\n}"},{"id":"01875059-71df-4b7f-97c9-0e1a87c920c8","name":"Update Speaker (With Images)","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"Tim","type":"text"},{"key":"last_name","value":"Cook","type":"text"},{"key":"email","value":"timcook@apple.com","type":"text"},{"key":"title","value":"CEO","type":"text"},{"key":"about","value":"CEO of Apple","type":"text"},{"key":"organization","value":"Apple","type":"text"},{"key":"location","value":"Cupertino","type":"text"},{"key":"picture","type":"file","src":"PheedLoop API Testing/images/windows.jpg"},{"key":"logo_company","type":"file","src":"PheedLoop API Testing/images/windows.jpg"}],"options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 15 Dec 2021 18:55:04 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPEAKER-CODE\",\n \"event\": \"{{eventCode}}\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"12timcook@apple.com\",\n \"designations\": \"He/Him\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [],\n \"tags\": [],\n \"picture\": \"{{Base URL}}media/events/{{Event Code}}/speakers/image_SPECADBRSOA_857216.jpg\",\n \"logo_company\": \"{{Base URL}}media/events/{{Event Code}}/speakers/image_SPECADBRSOA_58758.jpg\",\n \"code_internal\": \"CODE\"\n}"}],"_postman_id":"68b6e07e-8ae7-4f0a-bbe1-784be6bdb774"},{"name":"Delete Speaker","event":[{"listen":"test","script":{"id":"8ca1a6f1-bce4-4589-9947-5fb79689d628","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"speakerFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f938a5ce-82b2-4c39-a03e-d129bb872f3d","exec":[""],"type":"text/javascript"}}],"id":"77aee040-a268-47d1-94e1-ed9596bff909","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/","description":"Deletes a single Speaker from your specific event. A 200 will be returned on successful deletion along with the contents of the deleted Speaker.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","SPEAKER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"6cce1c59-508f-40ba-9427-29423c28195f","name":"Delete Speaker","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/SPEAKER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 20:09:26 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPEAKER-CODE\",\n \"event\": \"{{eventCode}}\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"designations\": \"He/Him\",\n \"title\": \"CEO\",\n \"about\": \"CEO of Apple\",\n \"organization\": \"Apple\",\n \"location\": \"Cupertino\",\n \"sessions\": [],\n \"tags\": [\n \"Speaker Tag\"\n ],\n \"picture\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_267511.png\",\n \"logo_company\": \"{{baseURL}}media/events/{{eventCode}}/speakers/image_SPEUBRZCCTT_311604.png\",\n \"code_internal\": \"CODE\"\n}"}],"_postman_id":"77aee040-a268-47d1-94e1-ed9596bff909"}],"id":"4395ff6d-b402-4ec9-864c-be1d0cd5e935","description":"A Speaker in PheedLoop is a person that is taking speaking at a session. They typically are advertised as a Speaker on promotional material and on the event website. Speakers are specific to events, but for convenience we do have some Organization wide endpoints.
\nSpeakers can be viewed from the dashboard under the All Events -> Speakers -> Speakers section. You may created, edit, and delete Speakers via this menu, as well as this API.
\nSeveral endpoints are available for getting and updating Speakers within the PheedLoop system. All of the Speaker endpoints require an organizationCode in their URL and event specific endpoints require an event_code in their URL.
Note that all endpoints below are assumed to be an Event endpoint unless stated with Organization Wide.
Lists announcements for a given event.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","announcements",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"563d4d08-e660-42be-9b0a-5d1e772d7459","name":"List Announcements","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/announcements/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 08 Jun 2022 16:06:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"1396"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"ANNXSG20EQ7IVGZ\",\n \"tags\": [\n 1621,\n 1620\n ],\n \"tickets\": [\n 4946\n ],\n \"title\": \"Welcome to New Event\",\n \"description\": \"We can't wait to see you there! This is a sample announcement.\",\n \"cta_text\": \"\",\n \"cta_link\": \"\",\n \"publish_date\": \"2022-06-07\",\n \"publish_time\": \"18:21:13.138035\",\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": true,\n \"is_multiple_send_enabled\": true,\n \"is_credentials_included\": false,\n \"is_add_to_calendar\": false,\n \"is_ebadge_included\": false,\n \"is_notification_push\": true,\n \"is_notification_mail\": true,\n \"is_visible_app\": true,\n \"is_visible_attendee\": true,\n \"is_visible_exhibitor\": true,\n \"is_visible_speaker\": true,\n \"is_visible_sponsor\": true,\n \"is_visible_virtual\": true,\n \"is_active\": true,\n \"status\": \"Sent\",\n \"deliveries\": 3\n },\n {\n \"code\": \"ANNTJ70KH7DWR42\",\n \"tags\": [],\n \"tickets\": [],\n \"title\": \"Testing Announcement 2\",\n \"description\": \"Your announcement goes here!\",\n \"cta_text\": \"\",\n \"cta_link\": \"\",\n \"publish_date\": \"2022-06-02\",\n \"publish_time\": null,\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": false,\n \"is_multiple_send_enabled\": true,\n \"is_credentials_included\": false,\n \"is_add_to_calendar\": false,\n \"is_ebadge_included\": false,\n \"is_notification_push\": true,\n \"is_notification_mail\": true,\n \"is_visible_app\": true,\n \"is_visible_attendee\": false,\n \"is_visible_exhibitor\": false,\n \"is_visible_speaker\": false,\n \"is_visible_sponsor\": false,\n \"is_visible_virtual\": false,\n \"is_active\": true,\n \"status\": \"Draft\",\n \"deliveries\": 3\n }\n ]\n}"}],"_postman_id":"04b5af5f-0f7b-4327-b509-4808fb5f0662"},{"name":"Get Announcement Details","event":[{"listen":"test","script":{"id":"0e263403-665b-4d76-86d7-8a398a351f27","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"announcementFieldsGet\"))","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"284e1615-e022-4d98-ad04-f5fc97f8e9ef","exec":[""],"type":"text/javascript"}}],"id":"63658044-a1e3-4f9d-ad53-b8db2286b60b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/announcements/ANNOUNCEMENT-CODE/","description":"View announcement details. For email and push notification announcements, the number of deliveries and a list of attendees who have already received the announcement are visible.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","announcements","ANNOUNCEMENT-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"4982ae82-5ecf-49ad-a93c-ef4c0efe44f3","name":"Get Announcement Details","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/announcements/ANNOUNCEMENT-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 08 Jun 2022 16:09:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"647"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ANNFVSQW4FQS57R\",\n \"tags\": [],\n \"tickets\": [],\n \"title\": \"Announcement Title\",\n \"description\": \"Announcement Description\",\n \"cta_text\": \"\",\n \"cta_link\": \"\",\n \"publish_date\": null,\n \"publish_time\": null,\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": false,\n \"is_multiple_send_enabled\": false,\n \"is_credentials_included\": false,\n \"is_add_to_calendar\": false,\n \"is_ebadge_included\": false,\n \"is_notification_push\": true,\n \"is_notification_mail\": true,\n \"is_visible_app\": true,\n \"is_visible_attendee\": false,\n \"is_visible_exhibitor\": false,\n \"is_visible_speaker\": false,\n \"is_visible_sponsor\": false,\n \"is_visible_virtual\": false,\n \"is_active\": true,\n \"status\": \"Draft\",\n \"deliveries\": 0,\n \"recipients\": []\n}"}],"_postman_id":"63658044-a1e3-4f9d-ad53-b8db2286b60b"},{"name":"Update Announcement","event":[{"listen":"test","script":{"id":"bd733352-849e-4ae9-9b76-2f6aea2dcfc7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"announcementFields\"))","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"8195373e-e24c-474c-8ead-7ffb7f6e1c54","exec":[""],"type":"text/javascript"}}],"id":"6b3c94af-e2cb-4e7c-a22b-c65f0d4f20fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title just got updated\",\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": true,\n \"is_released\": true,\n \"is_visible_app\": true,\n \"is_visible_attendee\": false,\n \"is_visible_virtual\": false,\n \"is_visible_exhibitor\": false,\n \"is_visible_speaker\": false,\n \"is_visible_sponsor\": false,\n \"publis_date\": null,\n \"publish_time\": null,\n \"release_date\": null,\n \"release_time\": null,\n \"cta_text\": \"\",\n \"cta_link\": \"\",\n \"is_credentials_included\": false,\n \"is_add_to_calendar\": false,\n \"is_ebadge_included\": false,\n \"description\": \"Description as too!\",\n \"tags\": [],\n \"tickets\": [],\n \"event\": \"EVETBCXWNLKBO\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/announcements/ANNOUNCEMENT-CODE/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","announcements","ANNOUNCEMENT-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"cd8436cb-d448-49e9-a45c-f370af10392d","name":"Update Announcement","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title just got updated\",\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": true,\n \"is_released\": true,\n \"is_visible_app\": true,\n \"is_visible_attendee\": false,\n \"is_visible_virtual\": false,\n \"is_visible_exhibitor\": false,\n \"is_visible_speaker\": false,\n \"is_visible_sponsor\": false,\n \"publis_date\": null,\n \"publish_time\": null,\n \"release_date\": null,\n \"release_time\": null,\n \"cta_text\": \"\",\n \"cta_link\": \"\",\n \"is_credentials_included\": false,\n \"is_add_to_calendar\": false,\n \"is_ebadge_included\": false,\n \"description\": \"Description as too!\",\n \"tags\": [],\n \"tickets\": [],\n \"event\": \"EVETBCXWNLKBO\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/announcements/ANNOUNCEMENT-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 08 Jun 2022 16:26:16 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"628"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ANNFVSQW4FQS57R\",\n \"tags\": [],\n \"tickets\": [],\n \"title\": \"Title just got updated\",\n \"description\": \"Description as too!\",\n \"cta_text\": \"\",\n \"cta_link\": \"\",\n \"publish_date\": null,\n \"publish_time\": null,\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": true,\n \"is_multiple_send_enabled\": true,\n \"is_credentials_included\": false,\n \"is_add_to_calendar\": false,\n \"is_ebadge_included\": false,\n \"is_notification_push\": false,\n \"is_notification_mail\": true,\n \"is_visible_app\": true,\n \"is_visible_attendee\": false,\n \"is_visible_exhibitor\": false,\n \"is_visible_speaker\": false,\n \"is_visible_sponsor\": false,\n \"is_visible_virtual\": false,\n \"is_active\": true,\n \"status\": \"Sent\",\n \"deliveries\": 1\n}"}],"_postman_id":"6b3c94af-e2cb-4e7c-a22b-c65f0d4f20fb"},{"name":"Get attendees subscrition information","event":[{"listen":"test","script":{"id":"b91acfc4-8a90-40ea-854b-bfbf2e2d9963","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"getAnnouncementRecipients\"))","});","","recipientsArray = [];","for (var i=0; i < pm.response.json().codes.length; i++)","{"," recipient = pm.response.json().codes[i]"," recipientsArray.push(`\"${recipient}\"`);","}","","pm.collectionVariables.set(\"recipientsSent\", recipientsArray)","","pm.collectionVariables.set(\"recipientsToSent\", pm.response.json().codes.length)",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"89c7ef1b-0dfc-43d8-b767-b146bf3d350c","exec":[""],"type":"text/javascript"}}],"id":"de977394-c67b-44f2-ba8d-848f9ae46041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/announcements/ANNOUNCEMENT-CODE/send/","description":"This endpoint will return a list of attendee codes for attendees who will receive the announcement if it's sent without a list of attendee_codes in the corresponding POST endpoint.
Use this endpoint to send an announcement if is_push or is_email is enabled. The attendee_codes field is optional. If it's included, then only the listed attendees will receive the announcement. If it's omitted, then the targeted attendees will receive it. Use the corresponding GET endpoint to determine which attendees will receive the announcement.
Use force_send to make sure that emails are sent to attendees who have unsubscribed or have already received the email.
Announcements in PheedLoop represent communications that can be sent or displayed to attendees. They can be see under the Communications section of the dashboard.
\nis_notification_push, is_notification_mail, is_visible_app, is_visible_attendee , is_visible_exhibitor, is_visible_speaker, is_visible_sponsor, and is_visible_virtual determine if the announcement is a push notification and/or email and which portals it should be visible in as a message.
tags and tickets are lists of tag codes and ticket codes which restrict which attendees should receive the announcement. If is_multiple_send_enabled is true, then emails can be sent more than once per attendee.
Returns a list of all tags in your chosen event. Each item in the list contains useful tag information.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the page_size query parameter. You may receive a specific page by using the page query parameter. For example: ?page=2&page_size=10.
Tags can be assigned Attendees which are then displayed in the Virtual Portal, Badges, PheedLoop GO, and other places.
\nTags can be used for visual references, be part of a Gamification Team or serve other uses. Tags can be found in the Dashboard by going to your chosen Event -> Attendees -> Tags.
\n","event":[{"listen":"prerequest","script":{"id":"f1918688-b501-4c5a-9b15-d547cc610c60","type":"text/javascript","exec":["pm.collectionVariables.set(\"tagFields\","," ["," \"id\","," \"code\","," \"name\","," \"event\","," \"description\","," ]",");"]}},{"listen":"test","script":{"id":"848e2e90-1422-4ca8-86b6-27d06bc3680d","type":"text/javascript","exec":[""]}}],"_postman_id":"b881f61c-b910-4dcd-afdf-b19449eb726e"},{"name":"Speaker Tags","item":[{"name":"Create Speaker Tag","event":[{"listen":"test","script":{"id":"f8fbde4e-3072-421f-9347-90b85e80c2f3","exec":["pm.test(\"Test speaker tag create endpoint return 201\", function(){"," pm.response.to.have.status(201);","})","","pm.collectionVariables.set('speakerTagCode', pm.response.json().code);"],"type":"text/javascript"}}],"id":"117cbb1f-a73f-4c70-80f0-5927a772f81b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Gold Tag\",\n \"color\": \"#00ffff\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"order_num\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/","description":"Creates a new Speaker Tag for your specified Event
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","tags",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"254fe7ea-42ab-47ef-bbf1-15a6aba494f7","name":"Create Speaker Tag","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Gold Tag\",\n \"color\": \"#00ffff\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"order_num\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:24:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"194"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPTZSQTWFUP\",\n \"title\": \"Gold Tag\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"color\": \"#00ffff\",\n \"order_num\": 0\n}"}],"_postman_id":"117cbb1f-a73f-4c70-80f0-5927a772f81b"},{"name":"List Speaker Tags","event":[{"listen":"test","script":{"id":"f8fbde4e-3072-421f-9347-90b85e80c2f3","exec":["pm.test(\"Test speaker tag list endpoint return 200\", function(){"," pm.response.to.have.status(200);","})","","pm.test(\"Test return speaker tags contain already created speaker tag code\", function(){"," var responseJSON = pm.response.json();"," pm.expect(responseJSON.results).to.be.an('array').that.is.not.empty;"," var codes = responseJSON.results.map(item => item.code);"," responseJSON.results.forEach((result) => {"," pm.expect(result.code).to.exist.and.to.be.a('string');"," });"," pm.expect(codes).to.include(pm.collectionVariables.get('speakerTagCode'))","})"],"type":"text/javascript"}}],"id":"577adbdd-2e62-4cb5-819f-2d1ca8d7ed9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/","description":"Returns a list of Speaker Tags for your specified Event.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?title=another will return Speaker Tag that are called Another Tag.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","tags",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"493e42ce-50ff-4aa4-bcac-4b6592a8a9d3","name":"List Speaker Tags","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:24:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"570"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 20,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/?page_size=10&page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SPTZSQTWFUP\",\n \"title\": \"Gold Tag\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"color\": \"#00ffff\",\n \"order_num\": 0\n }\n ]\n}"},{"id":"687ad484-d165-45ff-a84e-fc09f2bfb472","name":"Search Speaker Tags","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/?page_size=10&page=1&title=Gold","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","tags",""],"query":[{"key":"page_size","value":"10"},{"key":"page","value":"1"},{"key":"title","value":"Gold"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:24:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"570"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 20,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/?page_size=10&page=2&title=Gold\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SPTZSQTWFUP\",\n \"title\": \"Gold Tag\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"color\": \"#00ffff\",\n \"order_num\": 0\n }\n ]\n}"}],"_postman_id":"577adbdd-2e62-4cb5-819f-2d1ca8d7ed9e"},{"name":"Get Single Speaker Tag","event":[{"listen":"test","script":{"id":"f8fbde4e-3072-421f-9347-90b85e80c2f3","exec":["pm.test(\"Test single speaker tag endpoint return 200\", function(){"," pm.response.to.have.status(200);","})",""],"type":"text/javascript"}}],"id":"bbdcd0ee-ef96-4510-b7a7-6c4e1e13955c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/SPEAKER-TAG-CODE/","description":"Gets a single Speaker Tag for an Event, based on the Speaker Tag Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","tags","SPEAKER-TAG-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"29778562-8a85-4479-91d7-42c18e4aca8e","name":"Get Single Speaker Tag","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/SPEAKER-TAG-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:28:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"194"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPTZSQTWFUP\",\n \"title\": \"Gold Tag\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"color\": \"#00ffff\",\n \"order_num\": 0\n}"}],"_postman_id":"bbdcd0ee-ef96-4510-b7a7-6c4e1e13955c"},{"name":"Update Speaker Tag","event":[{"listen":"test","script":{"id":"f8fbde4e-3072-421f-9347-90b85e80c2f3","exec":["pm.test(\"Test single speaker tag endpoint return 200\", function(){"," pm.response.to.have.status(200);","})","","pm.test('Test speaker tag title updated successfully', function(){"," pm.expect(pm.response.json().title).to.equal(pm.collectionVariables.get('speakerTagTitle'));","})"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"fc350a13-87c6-4082-ab55-a7efb812fd9e","exec":["pm.collectionVariables.set('speakerTagTitle', 'Gold TagUpdate a single Speaker Tag, based on their code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","tags","SPEAKER-TAG-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"60df3e3e-941c-4154-b7eb-035a72b922fe","name":"Update Speaker Tag","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\",\n \"color\": \"#00ffff\",\n \"description\": \"These descriptions can be tailored based on the nature of the speaker and the specific benefits offered.\",\n \"order_num\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/SPEAKER-TAG-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:29:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"204"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPTZSQTWFUP\",\n \"title\": \"Gold TagDeletes a single Speaker Tag from your specific event. A 204 will be returned on successful deletion.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","speakers","tags","SPEAKER-TAG-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"844feb09-14a7-417c-b451-7005e8970aba","name":"Delete Speaker Tag","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/speakers/tags/SPEAKER-TAG-CODE/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:29:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"aafcf0de-de63-4330-96f6-7f90b6fb02e9"}],"id":"12e96bc3-77e1-4576-ae1c-29df2430f504","description":"Speaker tags in PHEEDLOOP serve as a valuable tool for categorizing speakers in an event, offering an efficient means to segment them for communication, display, and sorting purposes. These tags empower event organizers to optimize speaker management, ensuring a seamless and personalized experience for both speakers and attendees.
\nTo handle speaker tags on the dashboard, go to All Events -> Events -> Speakers, choose a particular speaker from the list, and find the Speaker Tag option under Advanced Options.
You may created, edit, and delete Speaker Tag via this menu, as well as this API.
\n","_postman_id":"12e96bc3-77e1-4576-ae1c-29df2430f504"},{"name":"Sponsor Tier","item":[{"name":"Create Sponsor Tier","event":[{"listen":"test","script":{"id":"abc5f057-7abf-4d09-b0d6-577608dfbfa1","exec":["pm.test(\"Test create sponsor tier return 201\", function(){"," pm.response.to.have.status(201)","})","","pm.collectionVariables.set('sponsorTierCode', pm.response.json().code);"],"type":"text/javascript"}}],"id":"e98f260c-9fc2-4feb-8ee3-9bfaf0129ad1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Gold Tier\",\n \"color\": \"#00ffff\",\n \"description\": \"New Sponsor tier\",\n \"order_num\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/","description":"Creates a new Sponsor Tier for your specified Event.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","tiers",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"3ef17ba5-d740-4f33-813b-b800a74a3823","name":"Create Sponsor Tier","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Gold Tier\",\n \"color\": \"#00ffff\",\n \"description\": \"New Sponsor tier\",\n \"order_num\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:02:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"113"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPTITSNLRJY0CES0VF\",\n \"name\": \"Gold Tier\",\n \"color\": \"#00ffff\",\n \"description\": \"New Sponsor tier\",\n \"order_num\": 0\n}"}],"_postman_id":"e98f260c-9fc2-4feb-8ee3-9bfaf0129ad1"},{"name":"List Sponsor Tiers","event":[{"listen":"test","script":{"id":"00ca24a4-e6f5-4de4-bd8b-1ffde28258f2","exec":["pm.test('Test list sponsor tier return 200', function(){"," pm.response.to.have.status(200);","})","","pm.test('Test list sponsor tier to have already created sponsor code', function () {"," var responseJSON = pm.response.json();"," pm.expect(responseJSON.results).to.be.an('array').that.is.not.empty;"," var codes = responseJSON.results.map(item => item.code);"," responseJSON.results.forEach((result) => {"," pm.expect(result.code).to.exist.and.to.be.a('string');"," });"," pm.expect(codes).to.include(pm.collectionVariables.get('sponsorTierCode'))","});"],"type":"text/javascript"}}],"id":"95291de9-8e34-484b-8050-ac87903622e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/","description":"Returns a list of Sponsor Tiers for your specified Event.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?name=another will return Sponsor Tier that are called Another Tier.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","tiers",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"8d61d6ad-88f0-4365-9a9f-afc9f8f62f69","name":"List Sponsor Tiers","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:00:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"759"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 20,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/?page_size=10&page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SPTII5K7UXIBUA8A1Q\",\n \"name\": \"Gold Tier\",\n \"color\": \"#00ffff\",\n \"description\": \"These descriptions can be tailored based on the nature of the sponsorship and the specific benefits offered.\",\n \"order_num\": 1\n }\n ]\n}"},{"id":"6357527e-eac1-4113-9e30-3c072ebc86a6","name":"Search Sponsor Tier","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/?name=Gold","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","tiers",""],"query":[{"key":"name","value":"Gold"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:00:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"759"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 20,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/?page_size=10&page=2&name=Gold\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"SPTII5K7UXIBUA8A1Q\",\n \"name\": \"Gold Tier\",\n \"color\": \"#00ffff\",\n \"description\": \"These descriptions can be tailored based on the nature of the sponsorship and the specific benefits offered.\",\n \"order_num\": 1\n }\n ]\n}"}],"_postman_id":"95291de9-8e34-484b-8050-ac87903622e4"},{"name":"Get Single Sponsor Tier","event":[{"listen":"test","script":{"id":"429b6f26-d71c-4e2b-add4-30cf1ef314b7","exec":["pm.test('Test request return status 200', function(){"," pm.response.to.have.status(200);","})","","pm.test('Test response code equal to request code', function(){"," pm.expect(pm.response.json().code).to.be.eql(pm.collectionVariables.get('sponsorTierCode'));","})"],"type":"text/javascript"}}],"id":"034dcdbe-3a96-4115-8d64-33144e9eacb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/SPONSOR-TIER-CODE/","description":"Gets a single Sponsor Tier for an Event, based on the Sponsor Tier Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","tiers","SPONSOR-TIER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"3a8bd1c5-2a53-467a-bc4d-112006d7cb19","name":"Get Single Sponsor Tier","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/SPONSOR-TIER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:03:04 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"113"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPTITSNLRJY0CES0VF\",\n \"name\": \"Gold Tier\",\n \"color\": \"#00ffff\",\n \"description\": \"New Sponsor tier\",\n \"order_num\": 0\n}"}],"_postman_id":"034dcdbe-3a96-4115-8d64-33144e9eacb3"},{"name":"Update Sponsor Tier","event":[{"listen":"prerequest","script":{"id":"207d4675-f6d5-46e2-b34d-d3250a23d162","exec":["pm.collectionVariables.set('sponsorTierTitle', 'Gold TierUpdate a single Sponsor Tier, based on their code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","tiers","SPONSOR-TIER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"e973181b-eb17-4502-86de-bd180152491d","name":"Update Sponsor Tier","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"color\": \"#00ffff\",\n \"description\": \"New Sponsor tier\",\n \"order_num\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/SPONSOR-TIER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:03:15 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"123"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"SPTITSNLRJY0CES0VF\",\n \"name\": \"Gold TierDeletes a single Sponsor Tier from your specific event. A 204 will be returned on successful deletion.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","tiers","SPONSOR-TIER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"3e0f37cf-211c-4ef8-be12-1fb32931bb71","name":"Delete Sponsor Tier","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/tiers/SPONSOR-TIER-CODE/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 16:03:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1664d7f7-fe50-42a1-841f-fc81de73a5d3"}],"id":"17431f1b-4177-4bc6-8df5-2c6ad2f3ccd1","description":"Sponsor tiers in PheedLoop are a strategic and effective method of categorizing sponsors for an event, providing a structured framework that tailors benefits to each sponsor's level of commitment. These tiers not only streamline the sponsorship process but also enhance the overall event experience for both sponsors and organizers.
\nThis feature can be access on the dashboard by navigating to All Events -> Events -> Sponsors -> Tiers. You may created, edit, and delete Sponsors Tier via this menu, as well as this API.
An Exhibitor Promotion in PheedLoop is used to offer exhibitors discounts, either as a percentage or a fixed monetary amount.
\nExhibitor Promotion are accessible from the Dashboard under your chosen Event -> Exhibitors -> Promotions.
\n","event":[{"listen":"prerequest","script":{"id":"ed055cbe-d5e8-4ee4-baf6-fdc4f964b725","type":"text/javascript","packages":{},"requests":{},"exec":["pm.collectionVariables.set(\"exhibitorPromotionFields\", "," ["," \"code\","," \"promotion_codes\","," \"event_code\","," \"name\","," \"description\","," \"is_active\","," \"limit\","," \"amount\","," \"percent\","," \"products\","," \"tax_percent\","," \"date_expiry\","," \"custom_fields\""," ]",");"]}},{"listen":"test","script":{"id":"ecef968c-a204-41de-a814-8ceafed81cb2","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"104fb70e-bd2b-4343-a7e5-e5eaf1646410"},{"name":"Sponsor Promotion","item":[{"name":"List Promotions","event":[{"listen":"test","script":{"id":"4be25ca4-39ec-4943-b0f1-48ba71e1ee05","exec":["pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.equal(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()['results'][0]).to.have.all.keys(pm.collectionVariables.get(\"sponsorPromotionFields\"));","});","","pm.collectionVariables.set(\"sponsorPromotionCode\", pm.response.json()['results'][0]['code']);",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b39f08d3-25e6-4400-a7ba-31a18d8e80d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/promotions/","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","promotions",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2133dd45-7428-47f0-9c0a-647775a29710","name":"List Promotions","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/promotions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Thu, 30 Oct 2025 15:16:21 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"2990"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"1\",\n \"promotion_codes\": \"20Deal\",\n \"event_code\": \"{{eventCode}}\",\n \"name\": \"20$ Off Promotion Deal\",\n \"description\": \"\",\n \"is_active\": true,\n \"limit\": 8000,\n \"amount\": 20,\n \"percent\": 0,\n \"products\": [\n {\n \"code\":\"PROGA8C41HG\",\n \"name\": \"Apple Watch\",\n \"tagline\":\"\",\n \"description\":\"\",\n \"price\":1.0,\n \"date_created\": \"2025-08-11T15:33:45.554284Z\",\n \"date_updated\": \"2025-08-11T15:33:45.554305Z\"\n }\n ],\n \"tax_percent\": 0,\n \"date_expiry\": \"2025-06-11\",\n \"custom_fields\": [\n {\n \"code\": \"CFDR8NAYI8TQYR9XXH4\",\n \"name\": \"required_field\",\n \"type\": \"TEXT\",\n \"label\": \"Required Field\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ]\n }\n ]\n}"}],"_postman_id":"b39f08d3-25e6-4400-a7ba-31a18d8e80d1"},{"name":"Get Single Promotion","event":[{"listen":"test","script":{"id":"9e19210b-8b55-4730-ba1d-e6befbda0fc9","exec":["pm.test(\"Status code is 200\", function () {"," pm.expect(pm.response.code).to.be.equal(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"sponsorPromotionFields\"));","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a71c51bb-c223-4143-9680-87fc5db40a07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/promotions//","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","sponsors","promotions","",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"4fcabf01-0a7f-4cbb-b267-fdaa7b358844","name":"Get Single Promotion","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/sponsors/promotions//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Thu, 30 Oct 2025 15:23:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"469"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"1257\",\n \"promotion_codes\": \"20Deal\",\n \"event_code\": \"{{eventCode}}\",\n \"name\": \"100% Deal\",\n \"description\": \"\",\n \"is_active\": true,\n \"limit\": 1000,\n \"amount\": 0,\n \"percent\": 100,\n \"products\": [\n {\n \"code\":\"PROGA8C41H1\",\n \"name\": \"Apple\",\n \"tagline\":\"\",\n \"description\": \"\",\n \"price\": 10.0,\n \"date_created\": \"2025-08-11T15:33:45.554284Z\",\n \"date_updated\": \"2025-08-11T15:33:45.554305Z\"\n }\n ],\n \"tax_percent\": 0,\n \"date_expiry\": null,\n \"custom_fields\": [\n {\n \"code\": \"CFDR8NAYI8TQYR9XXH42\",\n \"name\": \"required_field\",\n \"type\": \"TEXT\",\n \"label\": \"Required Field\",\n \"value\": [],\n \"options\": [],\n \"is_required\": false\n }\n ]\n}"}],"_postman_id":"a71c51bb-c223-4143-9680-87fc5db40a07"}],"id":"48a0f9a4-faa2-46c4-8b17-b8790a255905","description":"A Sponsor Promotion in PheedLoop is used to offer sponsors discounts, either as a percentage or a fixed monetary amount.
\nSponsor Promotion are accessible from the Dashboard under your chosen Event -> Sponsors -> Promotions.
\n","event":[{"listen":"prerequest","script":{"id":"c61af339-9b01-40e9-a145-1a3de25b4ca6","type":"text/javascript","packages":{},"requests":{},"exec":["pm.collectionVariables.set(\"sponsorPromotionFields\", "," ["," \"code\","," \"promotion_codes\","," \"event_code\","," \"name\","," \"description\","," \"is_active\","," \"limit\","," \"amount\","," \"percent\","," \"products\","," \"tax_percent\","," \"date_expiry\","," \"custom_fields\""," ]",");"]}},{"listen":"test","script":{"id":"fb2afea5-f5a1-4007-8d62-5235aad9a423","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"48a0f9a4-faa2-46c4-8b17-b8790a255905"}],"id":"df9b9c44-d9ec-41f6-a4c3-c2ae43fa983c","_postman_id":"df9b9c44-d9ec-41f6-a4c3-c2ae43fa983c","description":""},{"name":"Organizations Public APIs","item":[{"name":"Members","item":[{"name":"Create Member","event":[{"listen":"test","script":{"id":"f1c3de5d-eae7-4c79-8865-b7a243dfed02","exec":["if (pm.response.code == 303) {"," pm.test(\"Status code is 303\", function () {"," pm.response.to.have.status(303);"," });",""," pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"organizationAttendeeFields303\"));"," });",""," pm.collectionVariables.set(\"memberCode\", pm.response.json().additionalInformation);"," return","};","","pm.test(\"Status code is either 200 or 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201])","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"organizationAttendeeFields\"));","});","","pm.collectionVariables.set(\"memberCode\", pm.response.json().code);",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"200e4c2a-8fc8-4150-8f6c-da09e6283a87","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3baf2310-9c9e-4c40-85f6-c17e00f0411c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"timcook@apple.com\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"about\": \"CEO of Apple.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/","description":"Creates a new Member for your organization.
\nWhen a Member is updated, a 200 status is returned instead of a 201 status.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2c8fa44d-4721-4e61-92f8-551c1caa81fa","name":"Create Member Created","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"email\": \"timcook@apple.com\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"about\": \"CEO of Apple.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/"},"status":"CREATED","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 16:18:18 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"contact_groups\": [],\n \"contact_organization\": null,\n \"membership_tier\": null,\n \"about\": \"CEO of Apple.\",\n \"code\": \"ATTQGT9DDFU3V9EOFP5VSIKMPAZG\",\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"events_attended\": [],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n}"},{"id":"85c7f1b9-7ab1-4788-b1a9-fa3b91ef990b","name":"Create Member with Membership","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"email\": \"timcook@apple.com\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"about\": \"CEO of Apple.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"membership_tier\": \"MBTL0CGVRR21W\",\n \"start_date\": \"2024-01-01\",\n \"expiry_date\": \"2025-01-01\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/"},"status":"CREATED","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 16:18:18 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"email\": \"timcook@apple.com\",\n \"contact_groups\": [],\n \"contact_organization\": null,\n \"membership_tier\": null,\n \"about\": \"CEO of Apple.\",\n \"code\": \"ATTQGT9DDFU3V9EOFP5VSIKMPAZG\",\n \"title\": \"CEO\",\n \"organization\": \"Apple\",\n \"address_line_1\": \"One Apple Park Way\",\n \"address_line_2\": \"\",\n \"address_city\": \"Cupertino\",\n \"address_state\": \"CA\",\n \"address_zip\": \"95014\",\n \"address_country\": \"United States\",\n \"address_phone\": \"1-800-692-7753\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fruit only.\",\n \"accessibility_requirements\": \"Requires a personal helicopter\",\n \"designations\": \"He/Him\",\n \"events_attended\": [],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n}"}],"_postman_id":"3baf2310-9c9e-4c40-85f6-c17e00f0411c"},{"name":"Bulk Create Member","event":[{"listen":"test","script":{"id":"3f3f4474-7e8c-458d-9163-fdcd49b16160","exec":["pm.test(\"Status code is 200 or 201\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201])","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[0]).to.have.all.keys(pm.collectionVariables.get(\"organizationAttendeeFields\"));","});","","pm.collectionVariables.set(\"createdMemberCode1\", pm.response.json()[0].code);","pm.collectionVariables.set(\"createdMemberEmail1\", pm.response.json()[0].email);","pm.collectionVariables.set(\"createdMemberCode2\", pm.response.json()[1].code);","pm.collectionVariables.set(\"createdMemberEmail2\", pm.response.json()[1].email);",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"f490190b-7243-4d3c-9cea-277cbb6b3a43","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6678f00d-cc2e-4178-8c4a-5ca7ef92a2ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"tags\": [\n \"TAGJFOPSTYT\"\n ],\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/membersbulk/","description":"Creates several new Members for your organization.
\nAccepts a list of Member objects, using the same structure as defined in the single create endpoint.
\nIf an existing Member is found, it is updated instead of created, and a 200 status is returned instead of a 201 status. If you send over duplicate Members (using the same code field across several entries), you will only receive a single entry for each actual Member on the response.
Returns a list of Members (both across all your events and just in the Members list). Included is an events_attended field to help filter and sort if desired.
This endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nfirst_name
\nlast_name
\norganization
\nSearches will preform a regex sub string look up, so for example, you may filter the data by anyone with a @pheedloop.com email by passing the query ?email=@pheedloop.com.
Searches are case insensitive.
\nRegistration Date Filters
\nYou may also filter members by their most recent event registration date across all events in your account. The following query parameters are supported
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members",""],"host":["{{baseURL}}api"],"query":[{"disabled":true,"key":"registration_date_created_gte","value":"2025-11-04"},{"disabled":true,"key":"registration_date_created_lte","value":"2025-11-18"},{"disabled":true,"key":"registration_date_updated_gte","value":"2025-11-17"},{"disabled":true,"key":"registration_date_updated_lte","value":"2025-11-19"}],"variable":[]}},"response":[{"id":"5ef1820d-d37c-4595-ab16-4029cba37cf6","name":"List Members","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/?page_size=1","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","members",""],"query":[{"key":"page_size","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Nov 2021 21:21:54 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/members/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"The CEO of Niantic.\",\n \"code\": \"ATTN6EM521N4OJ04MDK7DLPD6HI0\",\n \"code_badge\": \"ATTHV52WKFZGEMB22L9XYO4CBEXN\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"code_internal\": \"12345\",\n \"dietary_restrictions\": \"Gluten\",\n \"accessibility_requirements\": \"None\",\n \"designations\": \"Him/His\",\n \"events_attended\": [\n \"EVEPLTXAWUFQQ\",\n \"EVEMQGSRJKNHG\",\n \"EVEDSYUXBMTBU\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n }\n ]\n}"},{"id":"0cab2771-f7dc-45a9-8073-a85f37fe2500","name":"Search Members","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/?first_name=John&last_name=Hanke","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","members",""],"query":[{"key":"first_name","value":"John"},{"key":"last_name","value":"Hanke"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 18:43:31 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"CEO of Niantic\",\n \"code\": \"ATTP9AQV8S1U6DV3A94N9L61QBT3\",\n \"code_badge\": \"ATTHV52WKFZGEMB22L9XYO4CBEXN\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"code_internal\": \"12345\",\n \"dietary_restrictions\": \"Gluten\",\n \"accessibility_requirements\": \"None\",\n \"designations\": \"Him/His\",\n \"events_attended\": [\n \"EVEMQGSRJKNHG\",\n \"EVEDSYUXBMTBU\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"0f80d6d0-5a1c-4a07-9fb7-17c2f6970a00"},{"name":"Get Single Member","event":[{"listen":"test","script":{"id":"2d3bb7a9-5f1c-4dd9-ba23-468ef694d86b","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"organizationAttendeeFields\"));","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"da3c774c-453f-48c1-83c7-755f5c7c58d9","exec":[""],"type":"text/javascript"}}],"id":"d06b38c1-2383-47d6-aecb-f76a99383d6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/MEMBER-CODE/","description":"Gets a single Member, based on the Member Code used in the URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","MEMBER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"dae31ee4-8f50-4c1e-862c-e907e1217eb9","name":"Get Single Member","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/MEMBER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Nov 2021 16:04:58 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PATCH, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"The CEO of Niantic.\",\n \"code\": \"MEMBER-CODE\",\n \"code_badge\": \"ATTHV52WKFZGEMB22L9XYO4CBEXN\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"14155708871\",\n \"code_internal\": \"12345\",\n \"dietary_restrictions\": \"Gluten\",\n \"accessibility_requirements\": \"None\",\n \"designations\": \"Him/His\",\n \"events_attended\": [\n \"EVEPLTXAWUFQQ\",\n \"EVEMQGSRJKNHG\",\n \"EVEDSYUXBMTBU\"\n ],\n \"linkedin\": \"\",\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n}"}],"_postman_id":"d06b38c1-2383-47d6-aecb-f76a99383d6f"},{"name":"Update Member","event":[{"listen":"test","script":{"id":"42b95039-1255-4c27-9231-14bfe551cee6","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," let fieldsToValidate = pm.collectionVariables.get(\"organizationAttendeeFields\");"," pm.expect(pm.response.json()).to.have.all.keys(fieldsToValidate);","});",""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"219396e9-e234-456c-b31b-a4a4c72cabce","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"eaf36595-1e89-4d25-819c-7def9203539d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/MEMBER-CODE/","description":"Update a single Member, based on their code. This will change the Member across all events they are a part of.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","MEMBER-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2cf7948b-c114-423b-a0c5-be151baabbc7","name":"Update Member","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/MEMBER-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Aug 2021 15:44:31 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PATCH, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"code\": \"MEMBER-CODE\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"linkedin\": \"\",\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n}"}],"_postman_id":"eaf36595-1e89-4d25-819c-7def9203539d"},{"name":"Bulk Update Member","event":[{"listen":"test","script":{"id":"9796badf-ad4c-4d86-8884-6629fb9fc229","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned in each list item\", function () {"," let fieldsToValidate = pm.collectionVariables.get(\"organizationAttendeeFields\");"," let filteredFieldsToValidate = fieldsToValidate.filter(field => field !== \"events_attended\");"," pm.expect(pm.response.json()[0]).to.have.all.keys(filteredFieldsToValidate);","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"478ca5a6-7218-4e46-8e28-f05dad121e61","exec":[""],"type":"text/javascript","packages":{}}}],"id":"8abbe7ed-9087-4efa-a6f6-0a5f4493d786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"code\": \"ATTA3RE94TM7OGJPOJU27HK6D7D6\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"code\": \"ATTIPZK5VT1DBUW472JBJGI8J1MG\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/membersbulk/","description":"Updates several Members, based on either their code or email. This will change the Member across all events they are a part of.
\nAccepts a list of Member objects, using the same structure as defined in the single update endpoint.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","membersbulk",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"250d4a98-f585-45d7-ab6b-515042860b03","name":"Update with Email","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"about\": \"The founder of Niantic.\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"about\": \"CEO and space traveller.\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"metadata\": {}\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/membersbulk/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 09 Aug 2021 20:44:12 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PATCH, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"first_name\": \"John\",\n \"last_name\": \"Hanke\",\n \"email\": \"john@niantic.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"The founder of Niantic.\",\n \"code\": \"ATT3HBIVHA6TC7UBMM7W80L82KM1\",\n \"title\": \"CEO\",\n \"organization\": \"Niantic\",\n \"address_line_1\": \"1 Ferry Building\",\n \"address_line_2\": \"Suite 200\",\n \"address_city\": \"San Francisco\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94111\",\n \"address_country\": \"United States\",\n \"address_phone\": \"4155708871\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Fish only\",\n \"accessibility_requirements\": \"Must be by the water.\",\n \"designations\": \"He/Him\",\n \"linkedin\": null,\n \"metadata\": {},\n \"all_memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n },\n {\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezoes\",\n \"email\": \"jeffbezos@amazon.com\",\n \"contact_groups\": [\n {\n \"code\": \"CTGFGAXDT9YCI\",\n \"name\": \"Email Blast\",\n \"description\": \"Email blasts for new event announcements!\"\n }\n ],\n \"contact_organization\": {\n \"code\": \"ATTORGWQNUELLV8R\",\n \"name\": \"Niantic\"\n },\n \"membership_tier\": {\n \"code\": \"MBTLMJH86VTPQ\",\n \"name\": \"Basic Tier\",\n \"price\": 100\n },\n \"about\": \"CEO and space traveller.\",\n \"code\": \"ATT52RJ426BNUE610TN67PT6U9Y3\",\n \"title\": \"CEO & Space Tourist\",\n \"organization\": \"Amazon\",\n \"address_line_1\": \"440 Terry Avenue North\",\n \"address_line_2\": \"\",\n \"address_city\": \"Seattle\",\n \"address_state\": \"WA\",\n \"address_zip\": \"98109\",\n \"address_country\": \"United States\",\n \"address_phone\": \"2062661000\",\n \"code_internal\": \"CODE\",\n \"dietary_restrictions\": \"Vegan\",\n \"accessibility_requirements\": \"Requires assisstance getting into rocketship\",\n \"designations\": \"He/Him\",\n \"linkedin\": null,\n \"metadata\": {},\n \"memberships\": [\n {\n \"membership_tier\": \"MBTRCW579CN5E\",\n \"membership_tier_name\": \"Test Membership\",\n \"date_start\": \"2024-01-01\",\n \"date_expiry\": \"2025-01-01\"\n }\n ]\n }\n]"}],"_postman_id":"8abbe7ed-9087-4efa-a6f6-0a5f4493d786"},{"name":"Convert Member/Attendee Emails to Codes","event":[{"listen":"test","script":{"id":"0f7ca3f6-7546-49b6-ba6c-8d94f8f668ac","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys("," ["," pm.collectionVariables.get(\"createdMemberEmail1\"),"," pm.collectionVariables.get(\"createdMemberEmail2\")"," ]"," );","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"b2510718-9aab-4e6f-abbf-45c468c15e7f","exec":[""],"type":"text/javascript"}}],"id":"8093ef3b-6718-457b-b436-41ef2b4caeef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"john@niantic.com\",\n \"jeffbezos@amazon.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/convertcodes/","description":"As the PheedLoop API uses Member/Attendee codes as the unique slug field, it may be desirable to convert the Member/Attendee's emails into our codes to store in your database. This can be useful if you are displaying a list of Member/Attendees to your users and want to present a human readable label, but still interact with the API natively.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","convertcodes",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"a1fd7f3c-96cb-41d8-bcab-b5060fb01671","name":"Convert Member/Attendee Emails to Codes","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"john@niantic.com\",\n \"timcook@apple.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/convertcodes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Aug 2021 15:49:53 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timcook@apple.com\": \"ATTLRN4HP5SBCJDNIXX7J6NZ44OC\",\n \"john@niantic.com\": \"ATT3HBIVHA6TC7UBMM7W80L82KM1\"\n}"}],"_postman_id":"8093ef3b-6718-457b-b436-41ef2b4caeef"}],"id":"3811989c-52b6-44bc-bd53-ff6c9ec26882","description":"A Member in PheedLoop are users that are related to your Organization, outside of an Event. Members are automatically created when Attendees registers for an event, you manually create them in the Dashboard, or you import/sync them from an external system.
\nAttendees and Members share the same underlying data model, but the object is referred to as an Attendee when dealing with Event level interactions, and a Member when dealing with Organization level interactions. Members don't necessarily need to be attending an Event to be counted as a Member.
\nMembers can be viewed in the Dashboard under by clicking on the Account Menu (the gear on the top right), then clicking Membership -> Members. This is the list of all Members currently assigned to your Organization. To see a Member as related to a specific event, (aka an Attendee) please refer to Attendees.
\nSeveral endpoints are available for getting and updating Members within the PheedLoop system. All of the Member endpoints are organization specific and require an organizationCode in their URL.
Note that as Members and Attendees share the same data model, any changes to a Member will affect the same Attendee across all events.
\n","event":[{"listen":"prerequest","script":{"id":"bcf43c1b-1835-4a02-bfa3-2935344a09ff","type":"text/javascript","requests":{},"exec":["pm.collectionVariables.set(\"organizationAttendeeFields\", "," ["," 'first_name', "," 'last_name',"," 'email',"," 'contact_groups',"," 'contact_organization',"," 'membership_tier',"," 'about', "," 'code',"," 'code_badge',"," 'title',"," 'organization', "," 'address_line_1',"," 'address_line_2',"," 'address_city', "," 'address_state',"," 'address_zip',"," 'address_country', "," 'address_phone',"," 'code_internal',"," 'dietary_restrictions', "," 'accessibility_requirements',"," 'designations',"," 'events_attended',"," 'linkedin',"," 'metadata',"," 'memberships',"," \"pronouns\","," \"contact_tags\","," \"external_qr_code_url\""," ]",");","","pm.collectionVariables.set(\"organizationAttendeeFields303\", "," ["," 'message', "," 'additionalInformation',"," ]",");",""]}},{"listen":"test","script":{"id":"2d242196-c2ac-40b2-ab76-d1dcae2485c7","type":"text/javascript","requests":{},"exec":[""]}}],"_postman_id":"3811989c-52b6-44bc-bd53-ff6c9ec26882"},{"name":"Announcements","item":[{"name":"Create Announcement","event":[{"listen":"test","script":{"id":"8f668b86-4cec-40c4-ac50-f0cf15acc71c","exec":["pm.test(\"Test announcement has status 201\", function () {"," pm.response.to.have.status(201);","});","","pm.test(\"All expected fields are returned in response\", function () {"," pm.expect(pm.response.json()).to.have.all.keys([\"code\", \"title\", \"description\", \"order_num\", \"date\", \"cta_text\", \"cta_link\", \"publish_date\", \"publish_time\", \"release_date\", \"release_time\", \"is_released\", \"is_credentials_included\", \"is_visible_attendee\", \"is_active\", \"status\", \"is_notification_mail\", \"is_notification_push\", \"is_multiple_send_enabled\", \"organization\", \"event_targets\", \"contact_groups\", \"exclude_event_targets\", \"membership_tiers_targets\", \"recipients\"]);","});","","pm.collectionVariables.set(\"organizationAnnouncementCode\", pm.response.json().code);",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"9dc648ce-34ae-451e-ba27-b3a55cbe59f6","exec":[""],"type":"text/javascript"}}],"id":"fc395f37-9be5-406c-a8d2-45443a0b6ffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"How to start using Pheedloop Announcement Feature.\",\n \"description\": \"To begin using Pheedloop's Announcement Feature, navigate to the dashboard, select 'Communication' and follow the intuitive prompts to create and share important updates with your audience seamlessly.\",\n \"order_num\": 0,\n \"date\": \"2023-11-30T14:14:10.417706Z\",\n \"cta_text\": \"Click Me!!!\",\n \"cta_link\": \"https://pheedloop.ca\",\n \"publish_date\": \"2023-11-30\",\n \"publish_time\": \"14:14\",\n \"is_released\": false,\n \"is_credentials_included\": true,\n \"is_visible_attendee\": false,\n \"is_active\": true,\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": false,\n \"event_targets\": [],\n \"contact_groups\": [],\n \"exclude_event_targets\": [],\n \"membership_tiers_targets\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements/","description":"Creates a new Announcement for your organization. When an Announcement is created, a 201 status is returned.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","announcements",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2b0605c1-e701-4aed-985f-ff827ea78300","name":"Create Announcement","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"How to start using Pheedloop Announcement Feature.\",\n \"description\": \"To begin using Pheedloop's Announcement Feature, navigate to the dashboard, select 'Communication' and follow the intuitive prompts to create and share important updates with your audience seamlessly.\",\n \"order_num\": 0,\n \"date\": \"2023-11-30T14:14:10.417706Z\",\n \"cta_text\": \"Click Me!!!\",\n \"cta_link\": \"https://localhost:8000\",\n \"publish_date\": \"2023-11-30\",\n \"publish_time\": \"14:14\",\n \"is_released\": false,\n \"is_credentials_included\": true,\n \"is_visible_attendee\": true,\n \"is_active\": true,\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": false,\n \"event_targets\": [],\n \"contact_groups\": [],\n \"exclude_event_targets\": [],\n \"membership_tiers_targets\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 06 Dec 2023 19:13:12 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"860"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ANNECH15XGYQG6W\",\n \"title\": \"How to start using Pheedloop Announcement Feature.\",\n \"description\": \"To begin using Pheedloop's Announcement Feature, navigate to the dashboard, select 'Communication' and follow the intuitive prompts to create and share important updates with your audience seamlessly.\",\n \"order_num\": 0,\n \"date\": \"2023-12-06T19:13:12.552718Z\",\n \"cta_text\": \"Click Me!!!\",\n \"cta_link\": \"https://localhost:8000\",\n \"publish_date\": \"2023-11-30\",\n \"publish_time\": \"19:14:00\",\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": false,\n \"is_credentials_included\": true,\n \"is_visible_attendee\": true,\n \"is_active\": true,\n \"status\": \"Draft\",\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": false,\n \"organization\": \"ORGLVQGQKKXJUQA02O\",\n \"event_targets\": [],\n \"contact_groups\": [],\n \"exclude_event_targets\": [],\n \"membership_tiers_targets\": [],\n \"recipients\": []\n}"}],"_postman_id":"fc395f37-9be5-406c-a8d2-45443a0b6ffb"},{"name":"List Announcements","event":[{"listen":"test","script":{"id":"e7e8e2e6-3658-4d87-99fd-331903ed715f","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"All expected fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[\"results\"][0]).to.have.all.keys(pm.collectionVariables.get(\"organizationAnnouncementFields\"));","});",""],"type":"text/javascript"}}],"id":"507baff1-d577-4ccf-9059-f18ce251e766","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements/","description":"Retrieves a list of all announcements within the organization.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","announcements",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"71eb5b3c-6de1-4fb7-aa1c-024ff9e984b4","name":"List Announcements","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 06 Dec 2023 17:13:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"896"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"ANN9SQ8JUBEK4S1\",\n \"title\": \"How to start using Pheedloop Announcement Feature.\",\n \"description\": \"To begin using Pheedloop's Announcement Feature, navigate to the dashboard, select 'Communication' and follow the intuitive prompts to create and share important updates with your audience seamlessly.\",\n \"order_num\": 0,\n \"date\": \"2023-12-06T16:01:42.080111Z\",\n \"cta_text\": \"Click Me!!!\",\n \"cta_link\": \"https://localhost:8000\",\n \"publish_date\": \"2023-11-30\",\n \"publish_time\": \"19:14:00\",\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": false,\n \"is_credentials_included\": true,\n \"is_visible_attendee\": true,\n \"is_active\": true,\n \"status\": \"Draft\",\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": false,\n \"organization\": \"{{organizationCode}}\",\n \"event_targets\": [],\n \"contact_groups\": [],\n \"exclude_event_targets\": [],\n \"membership_tiers_targets\": []\n }\n ]\n}"}],"_postman_id":"507baff1-d577-4ccf-9059-f18ce251e766"},{"name":"Get Single Announcement","event":[{"listen":"test","script":{"id":"2148aada-3a87-4d9c-bf3f-00b0bbacd16b","exec":["pm.test(\"Test announcement to return status 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Test organization announcement to return all expected fields\", function() {"," pm.expect(pm.response.json()).to.have.any.keys(pm.collectionVariables.get('organizationAnnouncementDetailFields'))","});",""],"type":"text/javascript"}}],"id":"5f94ae2f-2011-4b3f-a70f-8f9a145169f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements//","description":"View announcement details. For email and push notification announcements, the number of deliveries and a list of attendees who have already received the announcement are visible.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","announcements","",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"d5e26282-b3b4-4601-bd40-56ef31072d4b","name":"Get Single Announcement","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 06 Dec 2023 17:16:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"844"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ANNSUL1JLMZ10JX\",\n \"title\": \"How to start using Pheedloop Announcement Feature.\",\n \"description\": \"To begin using Pheedloop's Announcement Feature, navigate to the dashboard, select 'Communication' and follow the intuitive prompts to create and share important updates with your audience seamlessly.\",\n \"order_num\": 0,\n \"date\": \"2023-12-06T17:13:01.137913Z\",\n \"cta_text\": \"Click Me!!!\",\n \"cta_link\": \"https://localhost:8000\",\n \"publish_date\": \"2023-11-30\",\n \"publish_time\": \"19:14:00\",\n \"release_date\": null,\n \"release_time\": null,\n \"is_released\": false,\n \"is_credentials_included\": true,\n \"is_visible_attendee\": true,\n \"is_active\": true,\n \"status\": \"Draft\",\n \"is_notification_mail\": true,\n \"is_notification_push\": false,\n \"is_multiple_send_enabled\": false,\n \"organization\": \"\",\n \"event_targets\": [],\n \"contact_groups\": [],\n \"exclude_event_targets\": [],\n \"membership_tiers_targets\": []\n}"}],"_postman_id":"5f94ae2f-2011-4b3f-a70f-8f9a145169f2"},{"name":"Update Announcement","event":[{"listen":"prerequest","script":{"id":"79fc8356-663c-43b9-ad66-06337e6a50a6","exec":["pm.collectionVariables.set('organizationAnnouncementTitle', 'How to start using Pheedloop Announcement FeatureUpdates an existing organization announcement with the specified announcement_code. This endpoint allows authorized users to modify the content, title, or any other relevant attributes of a specific announcement within the organization.
attendee_codes in the corresponding POST endpoint.\n","urlObject":{"path":["v3","organization","{{organizationCode}}","announcements","","send",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"abd20089-9bd8-4631-a72f-0c968b4d782b","name":"Get Attendees subscription information","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements//send/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Wed, 06 Dec 2023 19:19:12 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"34073"}],"cookie":[],"responseTime":null,"body":"{\n \"announcement_code\": \"ANNECH15XGYQG6W\",\n \"codes\": [\n \"ATTLO2OXKVYHIT7RVXNSTAQKQHXF\",\n \"ATTYYQJ3U9U9QFZBT8TM5MQU1962\"\n ],\n \"unsubscribed\": [\n \"ATTHBRD2PWMPVM2CYA91J08Z95FY\"\n ]\n}"}],"_postman_id":"b6f6f241-09e3-4183-bcdb-acc1b193542f"},{"name":"Send Announcement","event":[{"listen":"test","script":{"id":"5876ac86-2d19-4868-bab3-198fd0061a0b","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"All excepted fields are returned in each list item\", function () {"," pm.expect(pm.response.json()[\"response_message\"]).to.be.oneOf([`Emails Sent to ${pm.collectionVariables.get(\"recipientsToSent\")} addresses, failed to send to 0 addresses`, \"Emails have been put in queue, you will receive a notification when they have finished sending\"])","});",""],"type":"text/javascript"}}],"id":"7d0bef0f-2be4-4207-b6ea-050b917373ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"attendee_codes\": [\n \n ],\n \"should_release\": true,\n \"force_send\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/announcements//send/","description":"Use this endpoint to send an announcement if is_push or is_email is enabled. The attendee_codes field is optional. If it's included, then only the listed attendees will receive the announcement. If it's omitted, then the targeted attendees will receive it. Use the corresponding GET endpoint to determine which attendees will receive the announcement.
Use force_send to make sure that emails are sent to attendees who have unsubscribed or have already received the email.
Delete an announcement with the specified announcement_code
Announcements in PheedLoop signify communications that members can receive or view, accessible within the Communications section of the dashboard. The attributes is_notification_push, is_notification_mail, and is_visible_attendee determine whether the announcement functions as a push notification and/or email.
The event_targets attribute comprises lists of event codes, designating the recipients for whom the announcement is intended. Similarly, contact_groups consist of lists of contact group codes, specifying the groups to receive the announcement.
For more targeted distribution, the membership_tiers_targets attribute includes a list of membership tier codes, representing the membership tiers of individuals who should receive the announcement.
For exclusions, the exclude_event_targets attribute provides a list of event codes, denoting the events to be excluded when sending the announcement to recipients.
If is_multiple_send_enabled is set to true, multiple emails can be sent to an attendee.
Creates a new Membership for your organization.
\nThis endpoint allow you to establish memberships seamlessly, offering flexibility with options for both assigned and unassigned memberships.
\nWhen creating an unassigned membership mark \"unassigned\": true in the payload, as this will give you ability to assign attendee to the membership at a later time.
Returns a list of Memberships.
\nThis endpoint is paginated with a default size of 500. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
You may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, you may filter the data by anyone with a @pheedloop.com email by passing the query ?email=@pheedloop.com.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","memberships",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"93b11536-473e-4662-8fb6-790d8238c27c","name":"List Memberships","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 18 Dec 2023 16:16:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"871"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/?page_size=10&page=1\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"MBRZDTPU6QK\",\n \"membership_tier\": \"MBTSJ53WV035C\",\n \"membership_name\": \"Sponsor\",\n \"date_start\": \"2023-12-18\",\n \"date_expiry\": \"2023-12-18\",\n \"organization\": \"ORGJDSGOVC8F7OCPLX\",\n \"notes\": \"\",\n \"attendee\": {\n \"email\": \"timcook@gmail.com\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"code\": \"ATTA5OLSVORKKBYHL6DJGXKV6NEG\",\n \"organization\": null\n },\n \"membership_order\": null,\n \"status\": \"soon\",\n \"is_active\": true,\n \"is_approved\": true\n }\n ]\n}"},{"id":"a2dabb11-7299-46ec-852b-1da83c4ae3a8","name":"Search Memberships","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/?email=timcook@gmail.com","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","memberships",""],"query":[{"key":"email","value":"timcook@gmail.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 18 Dec 2023 16:16:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"871"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/?page_size=10&page=1&email=timcook@gmail.com\",\n \"previous\": null,\n \"results\": [\n {\n \"code\": \"MBRZDTPU6QK\",\n \"membership_tier\": \"MBTSJ53WV035C\",\n \"membership_name\": \"Sponsor\",\n \"date_start\": \"2023-12-18\",\n \"date_expiry\": \"2023-12-18\",\n \"organization\": \"ORGJDSGOVC8F7OCPLX\",\n \"notes\": \"\",\n \"attendee\": {\n \"email\": \"timcook@gmail.com\",\n \"first_name\": \"Tim\",\n \"last_name\": \"Cook\",\n \"code\": \"ATTA5OLSVORKKBYHL6DJGXKV6NEG\",\n \"organization\": null\n },\n \"membership_order\": null,\n \"status\": \"soon\",\n \"is_active\": true,\n \"is_approved\": true\n }\n ]\n}"}],"_postman_id":"a07c566a-f702-4958-bf2d-81539cc7a5fb"},{"name":"Get Single Membership","event":[{"listen":"test","script":{"id":"6531efc0-fc4e-447d-b67f-72afcc360d50","exec":["pm.test(\"Test single membership endpoint return 200\", function(){"," pm.response.to.have.status(200);","})",""],"type":"text/javascript"}}],"id":"b5aaa3c4-fa91-47eb-8ea8-38f1f9d229a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/MEMBERSHIP-CODE/","description":"Returns detail information relating to supplied membership_code .
Update a single Membership based on their code.
\nPlease be aware that altering the membership tier of a membership already associated with a transaction is not permitted.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","memberships","MEMBERSHIP-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"4e7216f3-8aa9-41bf-b971-4131a7e6dba8","name":"Update Membership","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"membership_tier\": \"MBT27DU8QS4C3\",\n \"date_expiry\": \"2024-02-29\",\n \"date_start\": \"2023-12-01\",\n \"is_active\": true,\n \"notes\": \"Test membership notes updated\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/MEMBERSHIP-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 18 Dec 2023 16:51:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"304"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"MBR67EKFWLZ\",\n \"membership_tier\": \"MBT27DU8QS4C3\",\n \"membership_name\": \"Gold\",\n \"date_start\": \"2023-12-01\",\n \"date_expiry\": \"2024-02-29\",\n \"organization\": \"ORGJDSGOVC8F7OCPLX\",\n \"notes\": \"Test membership notes updated\",\n \"attendee\": null,\n \"membership_order\": null,\n \"status\": \"active\",\n \"is_active\": true,\n \"is_approved\": true\n}"}],"_postman_id":"1878077c-1372-4138-b8cf-cce1afa83d02"},{"name":"Assign Membership","event":[{"listen":"test","script":{"id":"c1cfa665-b482-49ad-8906-9160d2b90cfc","exec":["pm.test(\"Test update membership endpoint return 200\", function(){"," pm.response.to.have.status(200);","})","","pm.test('Test membership notes updated successfully', function(){"," pm.expect(pm.response.json().message).to.equal(\"Membership assigned successfully.\");","})"],"type":"text/javascript"}}],"id":"02fe7210-22b2-4cd1-80ff-84f78590ef68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"attendee\": \"UNASSIGNED-ATTENDEE-CODE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/MEMBERSHIP-CODE/assign/","description":"This endpoint allows you to assign and reassign an attendee to a membership based on membership code and attendee code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","memberships","MEMBERSHIP-CODE","assign",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"2ba2d3f2-37b4-4858-808e-0b358ad0c103","name":"Assign Membership","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"attendee\": \"UNASSIGNED-ATTENDEE-CODE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/MEMBERSHIP-CODE/assign/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 18 Dec 2023 16:53:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PATCH, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"47"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Membership assigned successfully.\"\n}"}],"_postman_id":"02fe7210-22b2-4cd1-80ff-84f78590ef68"},{"name":"Delete Membership","event":[{"listen":"test","script":{"id":"a27156de-964d-47c2-bd09-85058aa675a1","exec":["pm.test(\"Test delete membership endpoint return 204\", function(){"," pm.response.to.have.status(204);","})"],"type":"text/javascript"}}],"id":"97c5e96f-d083-4d15-a9b6-ffb33889b769","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/MEMBERSHIP-CODE/","description":"Delete a membership based on membership code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","memberships","MEMBERSHIP-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"a72fbf60-9846-47ef-9162-7151b05e428e","name":"Delete Membership","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/memberships/MEMBERSHIP-CODE/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 18 Dec 2023 16:42:15 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"97c5e96f-d083-4d15-a9b6-ffb33889b769"}],"id":"0ccfbe84-1594-4bd6-8d77-00a3d91c69c9","description":"A Membership in PHEEDLOOP typically refers to a structured program or arrangement that grants members certain privileges, benefits, or access to events based on their subscription or enrollment. Event organizers often use membership models to establish a loyal community, offer exclusive perks, and enhance the overall attendee experience.
\nMembership can be viewed in the Dashboard by clicking on the Account Menu (the gear on the top right), then clicking Membership -> Membership and click on Memberships Tab to view all your memberships. This is the list of all Members that are currently enrolled to any of your membership tier program.
\nNote that this endpoint is organization specific and require an organizationCode in their URL.
Creates a new Member Organization.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","organization",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"8473b61a-26a5-496c-aba9-fb8111136123","name":"Create Member Organization","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Pheedloop Inc\",\n \"internal_code\":\"ORG101\",\n \"payment_code_prefix\": \"UTP\",\n \"tax\": 1,\n \"managers\" : [],\n \"address_line_1\": \"Ontario Street\",\n \"address_line_2\": \"Ontario Street\",\n \"address_city\": \"Toronto\",\n \"address_state\": \"Toronto\",\n \"address_country\":\"Canada\",\n \"address_zip\" :\"90001\",\n \"address_phone_work\":\"2222222222\",\n \"website\" : \"https://www.pheedloop.com\",\n \"notes\":\"Organization Notes\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 20:29:30 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"421"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ATTORGMFDHM2OH71\",\n \"name\": \"Pheedloop Inc\",\n \"internal_code\": \"ORG101\",\n \"payment_code_prefix\": \"UTP\",\n \"tax\": 1,\n \"managers\": [],\n \"address_line_1\": \"Ontario Street\",\n \"address_line_2\": \"Ontario Street\",\n \"address_city\": \"Toronto\",\n \"address_state\": \"Toronto\",\n \"address_country\": \"Canada\",\n \"address_zip\": \"90001\",\n \"address_phone_work\": \"2222222222\",\n \"website\": \"https://www.pheedloop.com\",\n \"notes\": \"Organization Notes\"\n}"}],"_postman_id":"e3558e42-f3e7-4a9b-ae25-7189c2fea142"},{"name":"List Member Organization","event":[{"listen":"test","script":{"id":"b9dc94d2-d912-453b-b778-f4a888e6f50c","exec":["pm.test(\"Test member organization list endpoint return 200\", function(){"," pm.response.to.have.status(200);","})","","pm.test(\"Test return member organizations contain already created member organization code\", function(){"," var responseJSON = pm.response.json();"," pm.expect(responseJSON.results).to.be.an('array').that.is.not.empty;"," var codes = responseJSON.results.map(item => item.code);"," responseJSON.results.forEach((result) => {"," pm.expect(result.code).to.exist.and.to.be.a('string');"," });"," pm.expect(codes).to.include(pm.collectionVariables.get('memberOrganizationCode'))","})"],"type":"text/javascript"}}],"id":"e6502071-e856-4eb1-95fc-0366945fbcc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/","description":"Returns a list of Member Organizations.
\nYou may perform custom searches on this endpoint, to filter the data you wish to receive. Fields you are able to search for on this endpoint are:
\nSearches will preform a regex sub string look up, so for example, a query of ?name=another will return Member Organization that are called Another Members.
Searches are case insensitive.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","organization",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"1d3c5b86-18b7-41be-b703-27af26bbb603","name":"List Member Organization","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 20:35:54 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"152"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/?page=1&page_size=10\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"code\": \"ATTORG6J31P1L784\",\n \"name\": \"Goldman sach\"\n },\n {\n \"id\": 2,\n \"code\": \"ATTORGMFDHM2OH71\",\n \"name\": \"Pheedloop Inc\"\n }\n ]\n}"},{"id":"23416a44-ffe6-43b0-9432-0632611323a8","name":"Search Member Organization","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/?name=Goldman","host":["{{baseURL}}api"],"path":["v3","organization","{{organizationCode}}","members","organization",""],"query":[{"key":"name","value":"Goldman"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 20:50:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"101"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"code\": \"ATTORG6J31P1L784\",\n \"name\": \"Goldman sach\"\n }\n ]\n}"}],"_postman_id":"e6502071-e856-4eb1-95fc-0366945fbcc9"},{"name":"Get Single Member Organization","event":[{"listen":"test","script":{"id":"106ea6a3-1592-464e-8214-cfc6faaed298","exec":["pm.test(\"Test single member organization endpoint return 200\", function(){"," pm.response.to.have.status(200);","})",""],"type":"text/javascript"}}],"id":"4ff28289-99b4-4efb-b3a4-23652788c14b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/MEMBER-ORGANIZATION-CODE/","description":"Get Single Member Organization. This return a detail information of the member organization.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","organization","MEMBER-ORGANIZATION-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"4d28b8b2-0367-4704-9062-7a31f8349351","name":"Get Single Member Organization","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/MEMBER-ORGANIZATION-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 21:07:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"421"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ATTORGTGZN2J5NDU\",\n \"name\": \"Pheedloop Inc\",\n \"internal_code\": \"ORG101\",\n \"payment_code_prefix\": \"UTP\",\n \"tax\": 1,\n \"managers\": [],\n \"address_line_1\": \"Ontario Street\",\n \"address_line_2\": \"Ontario Street\",\n \"address_city\": \"Toronto\",\n \"address_state\": \"Toronto\",\n \"address_country\": \"Canada\",\n \"address_zip\": \"90001\",\n \"address_phone_work\": \"2222222222\",\n \"website\": \"https://www.pheedloop.com\",\n \"notes\": \"Organization test notes\"\n}"}],"_postman_id":"4ff28289-99b4-4efb-b3a4-23652788c14b"},{"name":"Update Member Organization","event":[{"listen":"prerequest","script":{"id":"ad49a581-59e7-4c32-8e7e-08cde79d649d","exec":["pm.collectionVariables.set('organizationName', 'Pheedloop Event Inc');"],"type":"text/javascript"}},{"listen":"test","script":{"id":"99aab192-0169-4395-acef-d5948b5e4ba9","exec":["pm.test(\"Test update member organization endpoint return 200\", function(){"," pm.response.to.have.status(200);","})","","pm.test('Test member organization title updated successfully', function(){"," pm.expect(pm.response.json().name).to.equal(pm.collectionVariables.get('organizationName'));","})"],"type":"text/javascript"}}],"id":"fbfb9356-b7d2-469a-810e-ec9eaed059cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"internal_code\":\"ORG101\",\n \"payment_code_prefix\": \"UTP\",\n \"tax\": 1,\n \"managers\" : [],\n \"address_line_1\": \"Ontario Street\",\n \"address_line_2\": \"Ontario Street\",\n \"address_city\": \"Toronto\",\n \"address_state\": \"Toronto\",\n \"address_country\":\"Canada\",\n \"address_zip\" :\"90001\",\n \"address_phone_work\":\"2222222222\",\n \"website\" : \"https://www.pheedloop.com\",\n \"notes\":\"Organization test notes\",\n \"extra\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/MEMBER-ORGANIZATION-CODE/","description":"Update a member organization based on the specified Member organization code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","organization","MEMBER-ORGANIZATION-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"3e4c7a7a-86d0-4ac8-8771-2c94d0dce860","name":"Update Member Organization","originalRequest":{"method":"PATCH","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"internal_code\":\"ORG101\",\n \"payment_code_prefix\": \"UTP\",\n \"tax\": 1,\n \"managers\" : [],\n \"address_line_1\": \"Ontario Street\",\n \"address_line_2\": \"Ontario Street\",\n \"address_city\": \"Toronto\",\n \"address_state\": \"Toronto\",\n \"address_country\":\"Canada\",\n \"address_zip\" :\"90001\",\n \"address_phone_work\":\"2222222222\",\n \"website\" : \"https://www.pheedloop.com\",\n \"notes\":\"Organization test notes\",\n \"extra\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/MEMBER-ORGANIZATION-CODE/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 21:10:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"427"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"ATTORGTGZN2J5NDU\",\n \"name\": \"Pheedloop Event Inc\",\n \"internal_code\": \"ORG101\",\n \"payment_code_prefix\": \"UTP\",\n \"tax\": 1,\n \"managers\": [],\n \"address_line_1\": \"Ontario Street\",\n \"address_line_2\": \"Ontario Street\",\n \"address_city\": \"Toronto\",\n \"address_state\": \"Toronto\",\n \"address_country\": \"Canada\",\n \"address_zip\": \"90001\",\n \"address_phone_work\": \"2222222222\",\n \"website\": \"https://www.pheedloop.com\",\n \"notes\": \"Organization test notes\"\n}"}],"_postman_id":"fbfb9356-b7d2-469a-810e-ec9eaed059cf"},{"name":"Delete Member Organization","event":[{"listen":"test","script":{"id":"e1d235b9-90d1-44cb-86ba-f1023b0516a2","exec":["pm.test(\"Test delete member organization endpoint return 204\", function(){"," pm.response.to.have.status(204);","})"],"type":"text/javascript"}}],"id":"7e1c080a-41f1-4059-bb56-dca4b564abfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/MEMBER-ORGANIZATION-CODE/","description":"Delete a member organization based on the specified Member organization code.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","members","organization","MEMBER-ORGANIZATION-CODE",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"9056d017-deb4-44ab-b68c-bdb377a2bc9c","name":"Delete Member Organization","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/members/organization/MEMBER-ORGANIZATION-CODE/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 11 Dec 2023 21:06:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.7.0"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7e1c080a-41f1-4059-bb56-dca4b564abfa"}],"id":"0ace3386-bc4e-4048-8cf9-5941fa6cc280","description":"The Member Organization in PHEEDLOOP introduces a systematic approach to categorizing members and associating them with specific organizations. This feature empowers organizations to efficiently manage and organize their members, offering a structured framework that enhances both member classification and financial management and gives the ability to indicate specific tax rates applicable to members in the organization.
\nTo view members organization on Dashboard, Click on the Account Menu (the top gear at the right hand corner) Membership -> Organizations -> **Organization Tab.**You can create, update, and delete Member organization using this menu as well as this API.
Get data from a Custom Report. This endpoint may be used to create any number advanced integrations. There are currently hundreds of fields available to query!
\nThis endpoint requires a reportCode in the URL. To get this code, navigate to your Custom Report in the dashboard and click on your report. The reportCode will appear in the URL. For example, from
dash.pheedloop.com/events/space/data/CustomReports#REPKLEH9UERNBSO
The reportCode is REPKLEH9UERNBSO. Alternatively, the code can be found by enabling the Code column in the Custom reports table.
This endpoint is paginated with a default and maximum size of 100. You may customize the page size with the optional page_size query parameter. You may receive a specific page by using the optional page query parameter. For example: ?page=2&page_size=10.
Data will be available in an array of objects under the results key. The keys and values will depend on the custom report you have created and will correspond with the header and table data that you see when downloading a report from the dashboard.
Reports in PheedLoop are found in your dashboard under Data & Reports > Custom Reports (dash.pheedloop.com/events//data/CustomReports).
\nNote: This is an advanced API endpoint. You must purchase the \"Advanced SmartSight\" Event Power-Up in order to use it.
\nAlso note that you must set up your custom report from the PheedLoop dashboard before being able to access it from this API.
\n","event":[{"listen":"prerequest","script":{"id":"6e87492f-a1b5-4f5d-8b26-467106ff1ce5","type":"text/javascript","exec":["pm.collectionVariables.set(\"reportFields\", "," ["," \"count\","," \"next\","," \"previous\","," \"results\","," ]",");"]}},{"listen":"test","script":{"id":"7b8ec85c-2cde-41ba-b5a6-22000a9daa15","type":"text/javascript","exec":[""]}}],"_postman_id":"3b312680-a88b-44ad-aaae-d91ab75d1cbc"},{"name":"REST Hooks","item":[{"name":"Create Hook","event":[{"listen":"test","script":{"id":"555773a9-1abf-4af6-bcb9-8506399a43a6","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});","","pm.test(\"All excepted fields are returned\", function () {"," pm.expect(pm.response.json()).to.have.all.keys(pm.collectionVariables.get(\"restHookFields\"));","});","","pm.test(\"Hook endpoint matches request\", function () {"," const requestEndpoint = JSON.parse(request.data).endpoint;"," pm.expect(pm.response.json().endpoint).to.equal(requestEndpoint);","});","","pm.collectionVariables.set(\"restHookCode\", pm.response.json().id)","pm.collectionVariables.set(\"hookEndpoint\", pm.response.json().endpoint)"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"503e1eb2-5e58-4e52-bc86-4b74cd8e83a7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c697005d-063a-4539-84e3-f3ffa261c67d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\":\"registration.created\",\n \"endpoint\":\"https://hooks.zapier.com/hooks/Create/subscribe to a new hook. Please see list of currently available hooks at the top of this section.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","resthooks",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"3a435077-e26f-47db-a6bf-17466f284273","name":"Create Hook","originalRequest":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"action\":\"session.created\",\n \"endpoint\":\"https://hooks.zapier.com/hooks/Returns all hooks currently registered to your organization. Use the id in the response when making PUT or DELETE requests.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","resthooks",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"7d7629e3-378d-4854-a527-7a2d8101b93a","name":"List Hooks","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/resthooks/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 25 Apr 2022 17:29:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"747"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"{{baseURL}}api/v3/organization/{{organizationCode}}/resthooks/?page=2&page_size=1\",\n \"previous\": null,\n \"results\": [\n {\n \"action\": \"session.created\",\n \"endpoint\": \"https://hooks.zapier.com/hooks/Return a single hook based on the ID or a 404 if not found.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","resthooks","REST-HOOK-ID",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"25635466-94a8-49b4-b189-78437128cd90","name":"Get Single Hook","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/events/{{eventCode}}/resthooks/REST-HOOK-ID/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Mon, 25 Apr 2022 17:49:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, PUT, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0"},{"key":"Content-Length","value":"162"}],"cookie":[],"responseTime":null,"body":"{\n \"action\": \"session.created\",\n \"endpoint\": \"https://hooks.zapier.com/hooks/Update an existing REST Hook based on the ID. Can be used to change the action or the endpoint URL.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","resthooks","REST-HOOK-ID",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"f80de174-9219-4b20-b412-8cd10bf727b0","name":"Update Single Hook","originalRequest":{"method":"PUT","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}"}],"body":{"mode":"raw","raw":"{\n \"action\":\"attendee.updated\",\n \"endpoint\":\"https://hooks.zapier.com/hooks/Delete/unsubscribe from a REST Hook based on the ID.
\n","urlObject":{"path":["v3","organization","{{organizationCode}}","events","{{eventCode}}","resthooks","REST-HOOK-ID",""],"host":["{{baseURL}}api"],"query":[],"variable":[]}},"response":[{"id":"48216f58-f5cb-4d85-abac-0a639290c7d5","name":"Delete Single Hook","originalRequest":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"{{apiV3Key}}","type":"text"},{"key":"X-API-SECRET","value":"{{apiV3Secret}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}api/v3/organization/{{organizationCode}}/resthooks/REST-HOOK-ID/"},"status":"NO CONTENT","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 03 Aug 2021 18:20:00 GMT"},{"key":"Server","value":"WSGIServer/0.1 Python/2.7.18"},{"key":"Vary","value":"Accept"},{"key":"Content-Length","value":"0"},{"key":"Allow","value":"GET, PUT, DELETE, HEAD, OPTIONS"},{"key":"PheedLoop-API-Version","value":"v3.3.0","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"379d8339-b154-48d7-b8d9-a3618da53427"}],"id":"4083a015-bbb7-4f05-8386-5a8e87d46b47","description":"REST Hooks are a form of Webhooks, based on the REST design philosophy. We expose several REST Hooks for integrators looking to receive real time updates from our system.
\nREST Hooks are treated as resources in our database. Each REST Hook is programmed to be sent whenever the associated event (listed below) happens in our system. As such, to receive a notification for that event, you would POST to the Create Hook endpoint which tells us what you would like to be notified for (the action) and where you would like to be notified (the url).
If you'd like to subscribe to our REST Hooks (to be notified when something changes in our database), the below documentation describes how you may subscribe or unsubscribe from our hooks. We have hooks currently available for the following:
\nattendee.created - Fired whenever an Attendee is created. An Attendee is marked as 'created' when it is added to an event. You can expect a payload of a single Attendee with the fields described in List Attendees.
\nattendee.updated - Fired whenever the Attendee fields change. You can expect a payload of a single Attendee with the fields described in List Attendees.
\nattendee.deleted - Fired whenever an Attendee is removed from an Event. You can expect a payload of a single Attendee with the fields described in List Attendees.
\nregistration.created - Fired when a user registers for an Event. You can expect a payload containing a single registration with the fields described in List Registrations.
\nregistration.updated - Fired when a registration from a Event is edited. You can expect a payload containing a single registration with the fields described in List Registrations.
\nregistration.deleted - Fired when a registration is deleted from a Event. You can expect a payload containing a single registration with the fields described in List Registrations.
\nticketpurchase.created - Fired when a user purchases a ticket for an Event. You can expect a payload containing a single Ticket Purchase with the fields described in List Ticket Purchases.
\nticketpurchase.updated - Fired when a ticket purchases it is updated for an Event. You can expect a payload containing a single Ticket Purchase with the fields described in List Ticket Purchases.
\nticketpurchase.deleted - Fired when a ticket purchases is deleted for an Event. You can expect a payload containing a single Ticket Purchase with the fields described in List Ticket Purchases.
\nsession.created - Fired when a Session is created for an Event. You can expect a payload containing a single Session with the fields described in List Sessions.
\nsession.updated - Fired when a Session is updated for an Event. You can expect a payload containing a single Session with the fields described in List Sessions.
\nsession.deleted - Fired when a Session is deleted for an Event. You can expect a payload containing a single Session with the fields described in List Sessions.
\nsessionattendance.created - Fired when an attendee checks-in to a session. You can expect a payload containing basic information about the attendee and the session.
\nsessionattendance.updated - Fired when an attendee checks-out from a session. You can expect a payload containing basic information about the attendee and the session.
\nexhibitor.created - Fired when an Exhibitor is created for an Event. You can expect a payload containing a single Exhibitor with the fields described in List Exhibitors.
\nexhibitor.updated - Fired when an Exhibitor is updated for an Event. You can expect a payload containing a single Exhibitor with the fields described in List Exhibitors.
\nexhibitor.deleted - Fired when an Exhibitor is deleted for an Event. You can expect a payload containing a single Exhibitor with the fields described in List Exhibitor.
\nsponsor.created - Fired when a Sponsor is created for an Event. You can expect a payload containing a single Sponsor with the fields described in List Sponsors.
\nsponsor.updated - Fired when a Sponsor is updated for an Event. You can expect a payload containing a single Sponsor with the fields described in List Sponsors.
\nsponsor.deleted - Fired when a Sponsor is deleted for an Event. You can expect a payload containing a single Sponsor with the fields described in List Sponsors.
\nspeaker.created - Fired when a Speaker is created for an Event. You can expect a payload containing a single Speaker with the fields described in List Speakers.
\nspeaker.updated - Fired when a Speaker is updated for an Event. You can expect a payload containing a single Speaker with the fields described in List Speakers.
\nspeaker.deleted - Fired when a Speaker is deleted for an Event. You can expect a payload containing a single Speaker with the fields described in List Speakers.
\nWebhook signature verification is a crucial step to ensure that the payloads received by your server are genuinely sent by the PheedLoop and have not been tampered with. PheedLoop will sign all event webhooks with a secret that can be found under the settings section of the webhooks module in your event dashboard.
\nBelow is a generic explanation of the signature verification process and a JavaScript example to help you implement it in your application.
\nObtain the Signature and Secret
\nEach request includes a header X-PHEEDLOOP-SIGNATURE.
The webhook secret can be obtained on the settings section of the webhooks module in the event dashboard.
\nCapture the Raw Payload
\nGenerate the HMAC Signature
\nHMAC-SHA256 hashing algorithm and the shared secret to generate a signature from the raw payload.Compare Signatures
\nBelow is a JavaScript example that demonstrates how to verify a webhook signature.
\nconst crypto = require('crypto');\n/**\n * Verifies the webhook signature.\n * @param {string} rawBody - The raw body of the request.\n * @param {string} receivedSignature - The signature received in the request header.\n * @param {string} secret - The shared secret key.\n * @returns {boolean} - Returns true if the signature is valid, otherwise false.\n */\nfunction verifyWebhookSignature(rawBody, receivedSignature, secret) {\n try {\n // Create an HMAC using the shared secret\n const hmac = crypto.createHmac('sha256', secret);\n hmac.update(rawBody); // Use the raw body as input\n // Generate the expected signature\n const expectedSignature = hmac.digest('base64');\n // Compare the received signature with the expected signature\n return receivedSignature === expectedSignature;\n } catch (error) {\n console.error('Error verifying webhook signature:', error);\n return false;\n }\n}\n// Example usage\nconst rawBody = '{\"example\": \"payload\"}'; // Replace with the actual raw body\nconst receivedSignature = 'received-signature-from-header'; // Replace with the actual signature from the header\nconst secret = 'your-shared-secret'; // Replace with your shared secret\nif (verifyWebhookSignature(rawBody, receivedSignature, secret)) {\n console.log('Webhook verified successfully');\n} else {\n console.error('Invalid webhook signature');\n}\n\n