{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/eventee.com" } ], "info": { "name": "Eventee Public API", "_postman_id": "1cb3d82e-5440-490f-8205-2caa84cca65a", "description": "Manage your event's program, speakers, partners, attendees and registrations from your own systems.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Event content", "description": "Read the whole program of your event in one call: halls, days, sessions, workshops, breaks, speakers and labels. Also lets you wipe content created while testing an integration.", "item": [ { "name": "Get event content", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/content", "query": [ { "key": "date", "value": "2024-06-01", "description": "Only return the program of this day (`Y-m-d`). Days without content return empty lists.", "disabled": false }, { "key": "with_overlapping", "value": "", "description": "Also include event days that have no content yet in `days`.", "disabled": true } ], "raw": "{{baseUrl}}\/public\/api\/v1\/content?date=2024-06-01&with_overlapping=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the complete program of the event: `halls`, `days`, `lectures` (sessions of type 0), `workshops` (sessions of type 1), `pauses` (breaks), `speakers` and `tracks` (labels). Use it to read back IDs or to mirror the agenda in another system." }, "response": [ { "header": [], "code": 200, "body": "{\"halls\":[{\"id\":1,\"name\":\"Main Stage\",\"order\":0,\"event_id\":42,\"created_at\":\"2024-05-20 10:00:00\",\"updated_at\":\"2024-05-20 10:00:00\",\"stream\":null}],\"days\":[{\"id\":1,\"date\":\"2024-06-01 00:00:00\",\"event_id\":42,\"content_url\":\"\"}],\"lectures\":[{\"id\":1,\"name\":\"Opening Keynote\",\"description\":\"Welcome and overview of the day.\",\"start\":\"2024-06-01 09:00:00\",\"end\":\"2024-06-01 10:00:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"discussion\":true,\"panel_discussion\":false,\"code\":\"a1b2c3\",\"moderating\":false,\"polling\":true,\"checkin\":false,\"type\":0,\"mentoring\":false,\"hall_id\":1,\"speakers\":[1],\"files\":[],\"available\":0,\"booked\":false,\"capacity\":0,\"booking_info\":[],\"stream\":{\"code\":\"k3j9d2xq\",\"url\":\"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ\",\"available\":false,\"is_live\":false,\"streamable_type\":\"Eventee\\\\Models\\\\Lecture\",\"streamable_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"availability\":null,\"type\":\"youtube\"},\"virtual_meeting\":null,\"tracks\":[1],\"event_id\":42,\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/lecture\/a1b2c3\",\"overlapping\":false,\"visible_in_groups\":[],\"mandatory_for_groups\":[],\"mandatory\":false}],\"workshops\":[{\"id\":2,\"name\":\"Hands-on: Building Integrations\",\"description\":\"Bring your laptop.\",\"start\":\"2024-06-01 11:00:00\",\"end\":\"2024-06-01 12:30:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:06:00\",\"updated_at\":\"2024-05-20 10:06:00\",\"discussion\":false,\"panel_discussion\":false,\"code\":\"d4e5f6\",\"moderating\":false,\"polling\":false,\"checkin\":true,\"type\":1,\"mentoring\":false,\"hall_id\":1,\"speakers\":[1],\"files\":[],\"available\":30,\"booked\":false,\"capacity\":30,\"booking_info\":[{\"id\":1,\"capacity\":30,\"speaker_id\":null,\"lecture_id\":2,\"available\":30,\"booked\":false,\"booked_attendees\":[]}],\"stream\":null,\"virtual_meeting\":null,\"tracks\":[],\"event_id\":42,\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/lecture\/d4e5f6\",\"overlapping\":false,\"visible_in_groups\":[],\"mandatory_for_groups\":[],\"mandatory\":false}],\"pauses\":[{\"id\":1,\"name\":\"Coffee Break\",\"description\":\"\",\"start\":\"2024-06-01 10:00:00\",\"end\":\"2024-06-01 10:30:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:10:00\",\"updated_at\":\"2024-05-20 10:10:00\",\"event_id\":42}],\"speakers\":[{\"id\":1,\"name\":\"Jane Doe\",\"email\":\"jane.doe@example.com\",\"phone\":\"\",\"bio_html\":\"Jane leads the platform team at Acme Corp.\",\"web\":\"https:\/\/janedoe.example.com\",\"facebook\":\"\",\"twitter\":\"\",\"linkedIn\":\"https:\/\/www.linkedin.com\/in\/janedoe\",\"instagram\":\"\",\"position\":\"CTO\",\"company\":\"Acme Corp\",\"country\":\"US\",\"language\":\"en\",\"event_id\":42,\"order\":0,\"photo\":\"https:\/\/files.eventee.co\/images\/jane-doe.jpg\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/jane-doe.jpg\",\"bio\":\"Jane leads the platform team at Acme Corp.\"}],\"tracks\":[{\"id\":1,\"name\":\"Technology\",\"color\":\"#3B82F6\",\"order\":0,\"created_at\":\"2024-05-20 10:15:00\",\"updated_at\":\"2024-05-20 10:15:00\"}]}", "name": "The program of the event" }, { "header": [], "code": 422, "body": "{\"message\":\"The date field must match the format Y-m-d.\",\"errors\":{\"date\":[\"The date field must match the format Y-m-d.\"]}}", "name": "Validation failed" } ] }, { "name": "Delete all program content", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/test\/content", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/test\/content" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "**Irreversible.** Deletes **all** sessions, breaks, halls, speakers and labels of the event at once. Intended for cleaning up after testing an integration before the real import. Partners, attendees, registrations and groups are not affected." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Content deleted" } ] } ] }, { "name": "Halls", "description": "Halls are the places (rooms, stages, or virtual spaces) where sessions take place. A session is placed in a hall through its `hall_id`.", "item": [ { "name": "Create hall", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/hall", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/hall" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Main Stage\",\"order\":0}" }, "description": "Creates a hall in the event. Use the returned `id` as `hall_id` when creating sessions." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":1,\"name\":\"Main Stage\",\"order\":0,\"event_id\":42,\"created_at\":\"2024-05-20 10:00:00\",\"updated_at\":\"2024-05-20 10:00:00\",\"stream\":null}", "name": "Hall created" }, { "header": [], "code": 422, "body": "{\"message\":\"The name field is required.\",\"errors\":{\"name\":[\"The name field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Update hall", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/hall\/:hall_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/hall\/:hall_id", "variable": [ { "id": "hall_id", "key": "hall_id", "value": 1, "description": "ID of the hall." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Main Stage\",\"order\":0}" }, "description": "Updates a hall. `name` is required; `order` is kept when omitted. The live stream is **removed** when `stream` is omitted." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"name\":\"Main Stage\",\"order\":0,\"event_id\":42,\"created_at\":\"2024-05-20 10:00:00\",\"updated_at\":\"2024-05-20 10:00:00\",\"stream\":null}", "name": "Hall updated" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Hall] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The name field is required.\",\"errors\":{\"name\":[\"The name field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Delete hall", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/hall\/:hall_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/hall\/:hall_id", "variable": [ { "id": "hall_id", "key": "hall_id", "value": 1, "description": "ID of the hall." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a hall. Sessions placed in the hall are kept, but no longer have a hall." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Hall deleted" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Hall] 999\"}", "name": "No resource with this ID exists" } ] } ] }, { "name": "Sessions", "description": "Sessions are the items of your program. A session is either a **lecture** (`type` 0) or a **workshop** (`type` 1). Workshops have a limited `capacity` that attendees can book. Speakers, labels and a hall are attached to a session by their IDs.", "item": [ { "name": "Create session", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/lecture", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/lecture" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Opening Keynote\",\"description\":\"Welcome and overview of the day.\",\"start\":\"2024-06-01 09:00:00\",\"end\":\"2024-06-01 10:00:00\",\"type\":0,\"hall_id\":1,\"speakers\":[1],\"tracks\":[1],\"discussion\":true,\"moderating\":false,\"polling\":true,\"checkin\":false,\"capacity\":30,\"stream\":\"https:\\\/\\\/www.youtube.com\\\/watch?v=dQw4w9WgXcQ\"}" }, "description": "Creates a lecture or a workshop. The session is placed on the event day matching `start`; the day is created when it does not exist yet. Speakers, labels and the hall must already exist - create them first and pass their IDs." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":1,\"name\":\"Opening Keynote\",\"description\":\"Welcome and overview of the day.\",\"start\":\"2024-06-01 09:00:00\",\"end\":\"2024-06-01 10:00:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"discussion\":true,\"panel_discussion\":false,\"code\":\"a1b2c3\",\"moderating\":false,\"polling\":true,\"checkin\":false,\"type\":0,\"mentoring\":false,\"hall_id\":1,\"speakers\":[1],\"files\":[],\"available\":0,\"booked\":false,\"capacity\":0,\"booking_info\":[],\"stream\":{\"code\":\"k3j9d2xq\",\"url\":\"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ\",\"available\":false,\"is_live\":false,\"streamable_type\":\"Eventee\\\\Models\\\\Lecture\",\"streamable_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"availability\":null,\"type\":\"youtube\"},\"virtual_meeting\":null,\"tracks\":[1],\"event_id\":42,\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/lecture\/a1b2c3\",\"overlapping\":false,\"visible_in_groups\":[],\"mandatory_for_groups\":[],\"mandatory\":false}", "name": "Session created" }, { "header": [], "code": 422, "body": "{\"message\":\"The start field must be a date before end.\",\"errors\":{\"start\":[\"The start field must be a date before end.\"]}}", "name": "Validation failed" } ] }, { "name": "Update session", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/lecture\/:lecture_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/lecture\/:lecture_id", "variable": [ { "id": "lecture_id", "key": "lecture_id", "value": 1, "description": "ID of the session." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Opening Keynote\",\"description\":\"Welcome and overview of the day.\",\"start\":\"2024-06-01 09:00:00\",\"end\":\"2024-06-01 10:00:00\",\"type\":0,\"hall_id\":1,\"speakers\":[1],\"tracks\":[1],\"discussion\":true,\"moderating\":false,\"polling\":true,\"capacity\":30,\"stream\":\"https:\\\/\\\/www.youtube.com\\\/watch?v=dQw4w9WgXcQ\"}" }, "description": "Replaces a session. This is a full update: `name`, `start` and `end` are required and **omitted `speakers`, `tracks`, `capacity` and `type` are reset** (see the individual fields). The hall and live stream are kept when omitted." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"name\":\"Opening Keynote\",\"description\":\"Welcome and overview of the day.\",\"start\":\"2024-06-01 09:00:00\",\"end\":\"2024-06-01 10:00:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"discussion\":true,\"panel_discussion\":false,\"code\":\"a1b2c3\",\"moderating\":false,\"polling\":true,\"checkin\":false,\"type\":0,\"mentoring\":false,\"hall_id\":1,\"speakers\":[1],\"files\":[],\"available\":0,\"booked\":false,\"capacity\":0,\"booking_info\":[],\"stream\":{\"code\":\"k3j9d2xq\",\"url\":\"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ\",\"available\":false,\"is_live\":false,\"streamable_type\":\"Eventee\\\\Models\\\\Lecture\",\"streamable_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"availability\":null,\"type\":\"youtube\"},\"virtual_meeting\":null,\"tracks\":[1],\"event_id\":42,\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/lecture\/a1b2c3\",\"overlapping\":false,\"visible_in_groups\":[],\"mandatory_for_groups\":[],\"mandatory\":false}", "name": "Session updated" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Lecture] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 404, "body": "{\"error\":\"no_date_for_datetime\"}", "name": "`start` is outside the days of the event" }, { "header": [], "code": 422, "body": "{\"message\":\"The start field must be a date before end.\",\"errors\":{\"start\":[\"The start field must be a date before end.\"]}}", "name": "Validation failed" } ] }, { "name": "Delete session", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/lecture\/:lecture_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/lecture\/:lecture_id", "variable": [ { "id": "lecture_id", "key": "lecture_id", "value": 1, "description": "ID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a session (lecture or workshop) including its questions, polls, bookings and ratings." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Session deleted" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Lecture] 999\"}", "name": "No resource with this ID exists" } ] } ] }, { "name": "Breaks", "description": "Breaks are slots in the agenda without a session, such as coffee breaks, lunch or registration. They only have a name, a description and a time range.", "item": [ { "name": "Create break", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/pause", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/pause" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Coffee Break\",\"start\":\"2024-06-01 10:00:00\",\"end\":\"2024-06-01 10:30:00\"}" }, "description": "Creates a break on the event day matching `start`; the day is created when it does not exist yet." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":1,\"name\":\"Coffee Break\",\"description\":\"\",\"start\":\"2024-06-01 10:00:00\",\"end\":\"2024-06-01 10:30:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:10:00\",\"updated_at\":\"2024-05-20 10:10:00\",\"event_id\":42}", "name": "Break created" }, { "header": [], "code": 422, "body": "{\"message\":\"The start field must be a date before end.\",\"errors\":{\"start\":[\"The start field must be a date before end.\"]}}", "name": "Validation failed" } ] }, { "name": "Update break", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/pause\/:pause_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/pause\/:pause_id", "variable": [ { "id": "pause_id", "key": "pause_id", "value": 1, "description": "ID of the break." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Coffee Break\",\"start\":\"2024-06-01 10:00:00\",\"end\":\"2024-06-01 10:30:00\"}" }, "description": "Updates a break. `name`, `start` and `end` are required; `description` is kept when omitted." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"name\":\"Coffee Break\",\"description\":\"\",\"start\":\"2024-06-01 10:00:00\",\"end\":\"2024-06-01 10:30:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:10:00\",\"updated_at\":\"2024-05-20 10:10:00\",\"event_id\":42}", "name": "Break updated" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Pause] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The start field must be a date before end.\",\"errors\":{\"start\":[\"The start field must be a date before end.\"]}}", "name": "Validation failed" } ] }, { "name": "Delete break", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/pause\/:pause_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/pause\/:pause_id", "variable": [ { "id": "pause_id", "key": "pause_id", "value": 1, "description": "ID of the break." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a break from the agenda." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Break deleted" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Pause] 999\"}", "name": "No resource with this ID exists" } ] } ] }, { "name": "Speakers", "description": "Speakers presenting at your event. Once created, attach a speaker to sessions through the session's `speakers` field.", "item": [ { "name": "Create speaker", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/speaker", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/speaker" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jane Doe\",\"email\":\"jane.doe@example.com\",\"photo\":\"https:\\\/\\\/acme.example.com\\\/team\\\/jane-doe.jpg\",\"bio\":\"Jane leads the platform team at Acme Corp.\",\"position\":\"CTO\",\"company\":\"Acme Corp\",\"web\":\"https:\\\/\\\/janedoe.example.com\",\"linkedIn\":\"https:\\\/\\\/www.linkedin.com\\\/in\\\/janedoe\",\"country\":\"US\",\"language\":\"en\"}" }, "description": "Creates a speaker profile in the event. Use the returned `id` in the `speakers` field of sessions." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":1,\"name\":\"Jane Doe\",\"email\":\"jane.doe@example.com\",\"phone\":\"\",\"bio_html\":\"Jane leads the platform team at Acme Corp.\",\"web\":\"https:\/\/janedoe.example.com\",\"facebook\":\"\",\"twitter\":\"\",\"linkedIn\":\"https:\/\/www.linkedin.com\/in\/janedoe\",\"instagram\":\"\",\"position\":\"CTO\",\"company\":\"Acme Corp\",\"country\":\"US\",\"language\":\"en\",\"event_id\":42,\"order\":0,\"photo\":\"https:\/\/files.eventee.co\/images\/jane-doe.jpg\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/jane-doe.jpg\",\"bio\":\"Jane leads the platform team at Acme Corp.\"}", "name": "Speaker created" }, { "header": [], "code": 422, "body": "{\"message\":\"The name field is required.\",\"errors\":{\"name\":[\"The name field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Update speaker", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/speaker\/:speakerTmp_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/speaker\/:speakerTmp_id", "variable": [ { "id": "speakerTmp_id", "key": "speakerTmp_id", "value": 1, "description": "ID of the speaker." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jane Doe\",\"email\":\"jane.doe@example.com\",\"photo\":\"https:\\\/\\\/acme.example.com\\\/team\\\/jane-doe.jpg\",\"bio\":\"Jane leads the platform team at Acme Corp.\",\"position\":\"CTO\",\"company\":\"Acme Corp\",\"web\":\"https:\\\/\\\/janedoe.example.com\",\"linkedIn\":\"https:\\\/\\\/www.linkedin.com\\\/in\\\/janedoe\",\"country\":\"US\",\"language\":\"en\"}" }, "description": "Partially updates a speaker: only the fields you send are changed, all others are kept." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"name\":\"Jane Doe\",\"email\":\"jane.doe@example.com\",\"phone\":\"\",\"bio_html\":\"Jane leads the platform team at Acme Corp.\",\"web\":\"https:\/\/janedoe.example.com\",\"facebook\":\"\",\"twitter\":\"\",\"linkedIn\":\"https:\/\/www.linkedin.com\/in\/janedoe\",\"instagram\":\"\",\"position\":\"CTO\",\"company\":\"Acme Corp\",\"country\":\"US\",\"language\":\"en\",\"event_id\":42,\"order\":0,\"photo\":\"https:\/\/files.eventee.co\/images\/jane-doe.jpg\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/jane-doe.jpg\",\"bio\":\"Jane leads the platform team at Acme Corp.\"}", "name": "Speaker updated" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\SpeakerTmp] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The name field must not be greater than 256 characters.\",\"errors\":{\"name\":[\"The name field must not be greater than 256 characters.\"]}}", "name": "Validation failed" } ] }, { "name": "Delete speaker", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/speaker\/:speakerTmp_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/speaker\/:speakerTmp_id", "variable": [ { "id": "speakerTmp_id", "key": "speakerTmp_id", "value": 1, "description": "ID of the speaker." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a speaker and removes them from all sessions." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Speaker deleted" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\SpeakerTmp] 999\"}", "name": "No resource with this ID exists" } ] } ] }, { "name": "Labels", "description": "Labels are colored tags used to categorize sessions (for example by track or topic). Attach labels to a session through the session's `tracks` field.", "item": [ { "name": "Create label", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/label", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/label" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Technology\",\"color\":\"#3B82F6\",\"order\":0}" }, "description": "Creates a label. Use the returned `id` in the `tracks` field of sessions." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":1,\"name\":\"Technology\",\"color\":\"#3B82F6\",\"order\":0,\"created_at\":\"2024-05-20 10:15:00\",\"updated_at\":\"2024-05-20 10:15:00\"}", "name": "Label created" }, { "header": [], "code": 422, "body": "{\"message\":\"The color field is required.\",\"errors\":{\"color\":[\"The color field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Update label", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/label\/:track_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/label\/:track_id", "variable": [ { "id": "track_id", "key": "track_id", "value": 1, "description": "ID of the label." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Technology\",\"color\":\"#3B82F6\",\"order\":0}" }, "description": "Updates a label. `name` and `color` are required; `order` is kept when omitted." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"name\":\"Technology\",\"color\":\"#3B82F6\",\"order\":0,\"created_at\":\"2024-05-20 10:15:00\",\"updated_at\":\"2024-05-20 10:15:00\"}", "name": "Label updated" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Track] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The color field is required.\",\"errors\":{\"color\":[\"The color field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Delete label", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/label\/:track_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/label\/:track_id", "variable": [ { "id": "track_id", "key": "track_id", "value": 1, "description": "ID of the label." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a label and removes it from all sessions." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Label deleted" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Track] 999\"}", "name": "No resource with this ID exists" } ] } ] }, { "name": "Partners", "description": "Partners are the companies presented at your event. A partner with a `logo_url` is listed as a **sponsor**, a partner with a `photo_url` is listed as an **exhibitor** (with an optional booth number). A partner can be both. Each partner has a detail page composed of sections (text, links, images, files, social links).", "item": [ { "name": "Create partner", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/partner", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/partner" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company\":\"Acme Corp\",\"description\":\"Cloud infrastructure for event organizers.\",\"logo_url\":\"https:\\\/\\\/acme.example.com\\\/logo.png\",\"photo_url\":\"https:\\\/\\\/acme.example.com\\\/booth.jpg\",\"booth_number\":\"A12\",\"web\":\"https:\\\/\\\/acme.example.com\",\"email\":\"hello@acme.example.com\",\"phone\":\"+1 555 0100\",\"address\":\"1 Market Street, San Francisco, CA\"}" }, "description": "Creates a partner. Provide `logo_url` to list it as a sponsor, `photo_url` (with `booth_number`) to list it as an exhibitor, or both. At least one of the two images is required. Sections of the detail page are managed separately with Update partner sections." }, "response": [ { "header": [], "code": 201, "body": "{\"id\":1,\"company\":\"Acme Corp\",\"description\":\"Cloud infrastructure for event organizers.\",\"web\":\"https:\/\/acme.example.com\",\"email\":\"hello@acme.example.com\",\"phone\":\"+1 555 0100\",\"address\":\"1 Market Street, San Francisco, CA\",\"code\":\"p7q8r9\",\"created_at\":\"2024-05-20 10:20:00\",\"updated_at\":\"2024-05-20 10:20:00\",\"sections\":[],\"exhibitor\":true,\"sponsor\":true,\"exhibitor_info\":{\"booth_number\":\"A12\",\"order\":0,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"sponsor_info\":{\"order\":0,\"sponsor_category_id\":null,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"logo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/partner\/p7q8r9\"}", "name": "Partner created" }, { "header": [], "code": 403, "body": "{\"error\":\"cannot_create_partner\"}", "name": "Partners are not available in the event's plan" }, { "header": [], "code": 422, "body": "{\"message\":\"The company field is required.\",\"errors\":{\"company\":[\"The company field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Update partner", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/partner\/:partner_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/partner\/:partner_id", "variable": [ { "id": "partner_id", "key": "partner_id", "value": 1, "description": "ID of the partner." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company\":\"Acme Corp\",\"description\":\"Cloud infrastructure for event organizers.\",\"logo_url\":\"https:\\\/\\\/acme.example.com\\\/logo.png\",\"photo_url\":\"https:\\\/\\\/acme.example.com\\\/booth.jpg\",\"booth_number\":\"A12\",\"web\":\"https:\\\/\\\/acme.example.com\",\"email\":\"hello@acme.example.com\",\"phone\":\"+1 555 0100\",\"address\":\"1 Market Street, San Francisco, CA\"}" }, "description": "Replaces a partner's details. This is a full update: text fields that are omitted are cleared, and omitting `logo_url` removes the sponsor listing, omitting `photo_url` removes the exhibitor listing. Sections are not touched." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"company\":\"Acme Corp\",\"description\":\"Cloud infrastructure for event organizers.\",\"web\":\"https:\/\/acme.example.com\",\"email\":\"hello@acme.example.com\",\"phone\":\"+1 555 0100\",\"address\":\"1 Market Street, San Francisco, CA\",\"code\":\"p7q8r9\",\"created_at\":\"2024-05-20 10:20:00\",\"updated_at\":\"2024-05-20 10:20:00\",\"sections\":[],\"exhibitor\":true,\"sponsor\":true,\"exhibitor_info\":{\"booth_number\":\"A12\",\"order\":0,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"sponsor_info\":{\"order\":0,\"sponsor_category_id\":null,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"logo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/partner\/p7q8r9\"}", "name": "Partner updated" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Partner] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The company field is required.\",\"errors\":{\"company\":[\"The company field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "Update partner sections", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/partner\/:partner_id\/sections", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/partner\/:partner_id\/sections", "variable": [ { "id": "partner_id", "key": "partner_id", "value": 1, "description": "ID of the partner." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sections\":[{\"id\":10,\"type\":0,\"title\":\"About Acme\",\"align\":\"left\",\"urls\":[{\"text\":\"Product page\",\"url\":\"https:\\\/\\\/acme.example.com\\\/product\"}]}]}" }, "description": "Replaces the sections of the partner's detail page. The order of the array is the display order. Existing sections are kept only when their `id` is included - sections not listed are deleted, entries without `id` are created. Send an empty `sections` array to remove all sections. Each section has a `type` and only the fields relevant to that type are used." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1,\"company\":\"Acme Corp\",\"description\":\"Cloud infrastructure for event organizers.\",\"web\":\"https:\/\/acme.example.com\",\"email\":\"hello@acme.example.com\",\"phone\":\"+1 555 0100\",\"address\":\"1 Market Street, San Francisco, CA\",\"code\":\"p7q8r9\",\"created_at\":\"2024-05-20 10:20:00\",\"updated_at\":\"2024-05-20 10:30:00\",\"sections\":[{\"id\":10,\"type\":0,\"data\":\"{\\\"title\\\":\\\"About Acme\\\",\\\"align\\\":\\\"left\\\"}\",\"order\":0},{\"id\":11,\"type\":1,\"data\":\"{\\\"html\\\":\\\"

We build cloud infrastructure for event organizers.<\/p>\\\",\\\"align\\\":\\\"left\\\"}\",\"order\":1},{\"id\":12,\"type\":2,\"data\":\"{\\\"urls\\\":[{\\\"text\\\":\\\"Product page\\\",\\\"url\\\":\\\"https:\/\/acme.example.com\/product\\\"}]}\",\"order\":2},{\"id\":13,\"type\":5,\"data\":\"{\\\"facebook\\\":\\\"\\\",\\\"twitter\\\":\\\"https:\/\/x.com\/acme\\\",\\\"linkedIn\\\":\\\"https:\/\/www.linkedin.com\/company\/acme\\\",\\\"youtube\\\":\\\"\\\",\\\"instagram\\\":\\\"\\\",\\\"general\\\":\\\"\\\"}\",\"order\":3}],\"exhibitor\":true,\"sponsor\":true,\"exhibitor_info\":{\"booth_number\":\"A12\",\"order\":0,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"sponsor_info\":{\"order\":0,\"sponsor_category_id\":null,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"logo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/partner\/p7q8r9\"}", "name": "Partner with its sections. Each section's `data` is a JSON-encoded string with the fields of its type." }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Partner] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The sections.0.type field is required.\",\"errors\":{\"sections.0.type\":[\"The sections.0.type field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "List partners", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/partners", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/partners" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all partners of the event with their sponsor\/exhibitor details and sections." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1,\"company\":\"Acme Corp\",\"description\":\"Cloud infrastructure for event organizers.\",\"web\":\"https:\/\/acme.example.com\",\"email\":\"hello@acme.example.com\",\"phone\":\"+1 555 0100\",\"address\":\"1 Market Street, San Francisco, CA\",\"code\":\"p7q8r9\",\"created_at\":\"2024-05-20 10:20:00\",\"updated_at\":\"2024-05-20 10:30:00\",\"sections\":[{\"id\":10,\"type\":0,\"data\":\"{\\\"title\\\":\\\"About Acme\\\",\\\"align\\\":\\\"left\\\"}\",\"order\":0},{\"id\":11,\"type\":1,\"data\":\"{\\\"html\\\":\\\"

We build cloud infrastructure for event organizers.<\/p>\\\",\\\"align\\\":\\\"left\\\"}\",\"order\":1},{\"id\":12,\"type\":2,\"data\":\"{\\\"urls\\\":[{\\\"text\\\":\\\"Product page\\\",\\\"url\\\":\\\"https:\/\/acme.example.com\/product\\\"}]}\",\"order\":2},{\"id\":13,\"type\":5,\"data\":\"{\\\"facebook\\\":\\\"\\\",\\\"twitter\\\":\\\"https:\/\/x.com\/acme\\\",\\\"linkedIn\\\":\\\"https:\/\/www.linkedin.com\/company\/acme\\\",\\\"youtube\\\":\\\"\\\",\\\"instagram\\\":\\\"\\\",\\\"general\\\":\\\"\\\"}\",\"order\":3}],\"exhibitor\":true,\"sponsor\":true,\"exhibitor_info\":{\"booth_number\":\"A12\",\"order\":0,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"sponsor_info\":{\"order\":0,\"sponsor_category_id\":null,\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null}},\"logo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"photo\":{\"id\":501,\"width\":1200,\"height\":800,\"type\":\"photo\",\"url\":\"https:\/\/files.eventee.co\/images\/acme-logo.png\",\"thumbnail\":\"https:\/\/files.eventee.co\/images\/thumbnail\/acme-logo.png\",\"giphy_id\":null},\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/partner\/p7q8r9\"}]", "name": "Partners of the event" } ] }, { "name": "Delete partner", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/partner\/:partner_id", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/partner\/:partner_id", "variable": [ { "id": "partner_id", "key": "partner_id", "value": 1, "description": "ID of the partner." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes a partner including its sections." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Partner deleted" }, { "header": [], "code": 403, "body": "{\"not_authorized\":\"You are not authorized to do this step.\"}", "name": "The resource does not belong to the event of your token" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\Partner] 999\"}", "name": "No resource with this ID exists" } ] } ] }, { "name": "Attendees", "description": "People taking part in your event. Invite attendees by email (optionally with their profile details, group and tickets), list them, check them in at the venue, or remove them from the event.", "item": [ { "name": "Invite attendees", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/attendee\/invite", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/attendee\/invite" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[{\"email\":\"john.smith@example.com\",\"first_name\":\"John\",\"last_name\":\"Smith\",\"company\":\"Globex\",\"position\":\"Product Manager\",\"group_id\":1,\"send_email\":true,\"tickets\":[{\"number\":\"TCK-0001\",\"title\":\"Standard\",\"type\":\"qr\"}]}]}" }, "description": "Adds people to the event as attendees. People who already have an Eventee account are added directly, others get a profile that is linked once they sign up with the same email. Set `send_email` to send them an invitation email. The first 25 entries are processed immediately, the rest in the background. Entries that fail validation and people who are admins or moderators of the event are skipped silently." }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\",\"qr_code\":\"https:\/\/files.eventee.co\/images\/qr\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23.png\"}", "name": "Invitations accepted. `url` is the event's join link and `qr_code` the URL of its QR code image." }, { "header": [], "code": 422, "body": "{\"message\":\"The users.0.email field must be a valid email address.\",\"errors\":{\"users.0.email\":[\"The users.0.email field must be a valid email address.\"]}}", "name": "Validation failed" } ] }, { "name": "Check in attendee", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/attendee\/:attendee_id\/checkin", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/attendee\/:attendee_id\/checkin", "variable": [ { "id": "attendee_id", "key": "attendee_id", "value": 7, "description": "ID of the attendee (the `id` from List participants)." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"checkin\":true}" }, "description": "Marks an attendee as checked in at the event (sets `checked_at` to now) or reverts the check-in. Use the `id` from List participants." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":7,\"email\":\"john.smith@example.com\",\"first_name\":\"John\",\"last_name\":\"Smith\",\"photo\":null,\"thumbnail\":null,\"company\":\"Globex\",\"position\":\"Product Manager\",\"imported\":false,\"anonymous\":false,\"invited\":true,\"email_valid\":true,\"has_tickets\":true,\"tickets_count\":1,\"group_id\":1,\"checked_at\":\"2024-06-01 08:45:12\",\"registered_at\":\"2024-05-21 08:00:00\",\"account_deleted\":false}", "name": "Attendee with the updated `checked_at`" }, { "header": [], "code": 400, "body": "{\"message\":\"unable_to_checkin\"}", "name": "The user is not a participant of the event" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [Eventee\\\\Models\\\\User] 999\"}", "name": "No resource with this ID exists" }, { "header": [], "code": 422, "body": "{\"message\":\"The checkin field is required.\",\"errors\":{\"checkin\":[\"The checkin field is required.\"]}}", "name": "Validation failed" } ] }, { "name": "List participants", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/participants", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/participants" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all participants of the event with their role, group, tickets and check-in time. `role` is `a` = admin, `m` = moderator, `l` = speaker, `e` = attendee. `url` is the participant's personal link (used for their QR code), `checked_at` is `null` until the participant is checked in. `email` is not always a valid address: anonymous participants and deleted accounts carry a placeholder that contains no `@` and cannot be contacted." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":7,\"email\":\"john.smith@example.com\",\"name\":\"John Smith\",\"first_name\":\"John\",\"last_name\":\"Smith\",\"company\":\"Globex\",\"position\":\"Product Manager\",\"role\":\"e\",\"group_id\":1,\"url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/user\/9c1f6a2e-5b3d-4c8e-a7f0-1e2d3c4b5a69\",\"tickets\":[{\"number\":\"TCK-0001\",\"title\":\"Standard\",\"type\":\"qr\"}],\"checked_at\":\"2024-06-01 08:45:12\",\"registered_at\":\"2024-05-21 08:00:00\",\"account_deleted\":false}]", "name": "Participants of the event" } ] }, { "name": "Remove attendee", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/attendee", "query": [ { "key": "email", "value": "john.smith%40example.com", "description": "URL-encoded email address of the attendee.", "disabled": false } ], "raw": "{{baseUrl}}\/public\/api\/v1\/attendee?email=john.smith%2540example.com" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the person with the given email from the event: their participation, invitation and tickets for this event are deleted. Their Eventee account is not affected. Succeeds even when no attendee with that email exists." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Attendee removed" }, { "header": [], "code": 422, "body": "{\"message\":\"The email field is required.\",\"errors\":{\"email\":[\"The email field is required.\"]}}", "name": "Validation failed" } ] } ] }, { "name": "Registrations", "description": "Registrations are sign-ups collected through your event's registration. Use these endpoints to pre-register people from another system, list them, or remove a registration.", "item": [ { "name": "Create registrations", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/registration\/invite", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/registration\/invite" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"registrations\":[{\"email\":\"john.smith@example.com\",\"first_name\":\"John\",\"last_name\":\"Smith\",\"company\":\"Globex\",\"position\":\"Product Manager\",\"group_id\":1,\"send_email\":true}]}" }, "description": "Pre-registers people for the event. An existing registration with the same email is updated instead of duplicated. Set `send_email` to notify the person by email. The first 25 entries are processed immediately, the rest in the background. Entries that fail validation are skipped silently." }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\",\"qr_code\":\"https:\/\/files.eventee.co\/images\/qr\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23.png\"}", "name": "Registrations accepted. `url` is the event's join link and `qr_code` the URL of its QR code image." }, { "header": [], "code": 422, "body": "{\"message\":\"The registrations.0.email field must be a valid email address.\",\"errors\":{\"registrations.0.email\":[\"The registrations.0.email field must be a valid email address.\"]}}", "name": "Validation failed" } ] }, { "name": "List registrations", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/registrations", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/registrations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all registrations of the event. `status` is `0` = pending, `1` = confirmed (attending), `2` = declined." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1,\"email\":\"john.smith@example.com\",\"email_valid\":true,\"status\":0,\"first_name\":\"John\",\"last_name\":\"Smith\",\"photo\":null,\"phone\":\"\",\"bio\":\"\",\"web\":\"\",\"facebook_link\":\"\",\"twitter_link\":\"\",\"linkedIn_link\":\"\",\"position\":\"Product Manager\",\"company\":\"Globex\",\"answer_histories\":[],\"group_id\":1,\"created_at\":\"2024-05-21 08:00:00\",\"updated_at\":\"2024-05-21 08:00:00\",\"form_id\":null,\"form_answers\":[],\"account_deleted\":false}]", "name": "Registrations of the event" } ] }, { "name": "Remove registration", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/registration", "query": [ { "key": "email", "value": "john.smith%40example.com", "description": "URL-encoded email address of the registration.", "disabled": false } ], "raw": "{{baseUrl}}\/public\/api\/v1\/registration?email=john.smith%2540example.com" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the registration with the given email address. Succeeds even when no such registration exists." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Registration removed" }, { "header": [], "code": 422, "body": "{\"message\":\"The email field is required.\",\"errors\":{\"email\":[\"The email field is required.\"]}}", "name": "Validation failed" } ] } ] }, { "name": "Groups", "description": "Attendee groups let you tailor the agenda and app features to different audiences (for example VIP guests or staff). Use a group's `id` as `group_id` when inviting attendees or registrations.", "item": [ { "name": "List groups", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/groups", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/groups" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the attendee groups of the event. The boolean fields tell which app features are enabled for the group, `ticket_names` lists the ticket names that put attendees into the group automatically, `is_default` marks the group new attendees join by default." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1,\"name\":\"VIP\",\"public_name\":\"VIP guests\",\"color\":\"#FF5733\",\"emoji\":\"\u2b50\",\"agenda\":true,\"questions\":true,\"polling\":true,\"newsfeed\":true,\"networking\":true,\"session_ratings\":true,\"social_wall\":true,\"gamification\":true,\"ticket_names\":[\"VIP Ticket\"],\"is_default\":false,\"notification_suffix\":\"\",\"event_id\":42,\"created_at\":\"2024-05-20 10:25:00\",\"updated_at\":\"2024-05-20 10:25:00\",\"deleted_at\":null}]", "name": "Groups of the event" } ] } ] }, { "name": "Reviews", "description": "Session ratings left by attendees in the app: 1 to 5 stars with an optional comment.", "item": [ { "name": "List reviews", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/api\/v1\/reviews", "query": [], "raw": "{{baseUrl}}\/public\/api\/v1\/reviews" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all session ratings of the event. Each review includes the rated session as `lecture` and the reviewer's name and photo." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1,\"stars\":5,\"comment\":\"Excellent session, very practical.\",\"device\":\"iPhone 15\",\"OS\":\"iOS 17.5\",\"lecture_id\":1,\"user_id\":7,\"created_at\":\"2024-06-01 10:05:00\",\"updated_at\":\"2024-06-01 10:05:00\",\"username\":\"John Smith\",\"userphoto\":\"https:\/\/files.eventee.co\/images\/thumbnail\/john-smith.jpg\",\"account_deleted\":false,\"lecture\":{\"id\":1,\"name\":\"Opening Keynote\",\"description\":\"Welcome and overview of the day.\",\"start\":\"2024-06-01 09:00:00\",\"end\":\"2024-06-01 10:00:00\",\"event_day_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"discussion\":true,\"panel_discussion\":false,\"code\":\"a1b2c3\",\"moderating\":false,\"polling\":true,\"checkin\":false,\"type\":0,\"mentoring\":false,\"hall_id\":1,\"speakers\":[1],\"files\":[],\"available\":0,\"booked\":false,\"capacity\":0,\"booking_info\":[],\"stream\":{\"code\":\"k3j9d2xq\",\"url\":\"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ\",\"available\":false,\"is_live\":false,\"streamable_type\":\"Eventee\\\\Models\\\\Lecture\",\"streamable_id\":1,\"created_at\":\"2024-05-20 10:05:00\",\"updated_at\":\"2024-05-20 10:05:00\",\"availability\":null,\"type\":\"youtube\"},\"virtual_meeting\":null,\"tracks\":[1],\"event_id\":42,\"qr_code_url\":\"https:\/\/app.eventee.co\/event\/3f2b1c9e-8d47-4e6a-9b0c-2d5e7f8a1b23\/lecture\/a1b2c3\",\"overlapping\":false,\"visible_in_groups\":[],\"mandatory_for_groups\":[],\"mandatory\":false}}]", "name": "Reviews of the event" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }