{ "info": { "name": "RoadOps Developer API", "description": "Generated from the RoadOps Developer API OpenAPI contract. Set the collection variables before sending requests.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.roadops.app/v1", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "dayId", "value": "", "type": "string" }, { "key": "eventId", "value": "", "type": "string" }, { "key": "fileId", "value": "", "type": "string" }, { "key": "guestRequestId", "value": "", "type": "string" }, { "key": "lodgingId", "value": "", "type": "string" }, { "key": "memberId", "value": "", "type": "string" }, { "key": "noteId", "value": "", "type": "string" }, { "key": "passTypeId", "value": "", "type": "string" }, { "key": "scheduleItemId", "value": "", "type": "string" }, { "key": "setListId", "value": "", "type": "string" }, { "key": "setListItemId", "value": "", "type": "string" }, { "key": "teamId", "value": "", "type": "string" }, { "key": "ticketTypeId", "value": "", "type": "string" }, { "key": "userGroupId", "value": "", "type": "string" }, { "key": "userId", "value": "", "type": "string" }, { "key": "venueId", "value": "", "type": "string" } ], "item": [ { "name": "Teams", "item": [ { "name": "List teams", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams", "host": [ "{{baseUrl}}" ], "path": [ "teams" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ] }, "description": "Lists teams visible to the token owner." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams", "host": [ "{{baseUrl}}" ], "path": [ "teams" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ] }, "description": "Lists teams visible to the token owner." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000100\",\n \"name\": \"RoadOps Touring\",\n \"role\": \"admin\",\n \"status\": \"active\",\n \"organizationStatus\": \"active\",\n \"version\": 14,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Members", "item": [ { "name": "List members", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists active team members." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists active team members." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000932\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"membershipId\": \"00000000-0000-4000-8000-000000000933\",\n \"userId\": \"00000000-0000-4000-8000-000000000932\",\n \"role\": \"user\",\n \"status\": \"active\",\n \"joinedAt\": \"2026-09-01T12:00:00.000Z\",\n \"grantedAt\": \"2026-09-01T12:00:00.000Z\",\n \"grantedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"memberName\": \"Crew Member\",\n \"givenName\": \"Crew\",\n \"familyName\": \"Member\",\n \"memberEmail\": \"crew@example.com\",\n \"memberPicture\": \"https://assets.roadops.app/public/profiles/crew-member.jpg\",\n \"scheduleNoticeWindow\": \"24h\",\n \"automaticRemovalDate\": \"2026-10-01\",\n \"version\": 1,\n \"membershipVersion\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Invite a member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to invite a team member. The active member record becomes available after the invitation is accepted and projected.", "body": { "mode": "raw", "raw": "{\n \"invitationId\": \"00000000-0000-4000-8000-000000000931\",\n \"email\": \"crew@example.com\",\n \"role\": \"user\",\n \"message\": \"Welcome to the tour.\",\n \"automaticRemovalDate\": \"2026-10-01\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to invite a team member. The active member record becomes available after the invitation is accepted and projected.", "body": { "mode": "raw", "raw": "{\n \"invitationId\": \"00000000-0000-4000-8000-000000000931\",\n \"email\": \"crew@example.com\",\n \"role\": \"user\",\n \"message\": \"Welcome to the tour.\",\n \"automaticRemovalDate\": \"2026-10-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000931\",\n \"resourceType\": \"member_invitation\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/members\"\n }\n}" } ] }, { "name": "Retrieve a member", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Returns one active team member by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Returns one active team member by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000932\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"membershipId\": \"00000000-0000-4000-8000-000000000933\",\n \"userId\": \"00000000-0000-4000-8000-000000000932\",\n \"role\": \"user\",\n \"status\": \"active\",\n \"joinedAt\": \"2026-09-01T12:00:00.000Z\",\n \"grantedAt\": \"2026-09-01T12:00:00.000Z\",\n \"grantedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"memberName\": \"Crew Member\",\n \"givenName\": \"Crew\",\n \"familyName\": \"Member\",\n \"memberEmail\": \"crew@example.com\",\n \"memberPicture\": \"https://assets.roadops.app/public/profiles/crew-member.jpg\",\n \"scheduleNoticeWindow\": \"24h\",\n \"automaticRemovalDate\": \"2026-10-01\",\n \"version\": 1,\n \"membershipVersion\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a member", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Accepts one or more commands to update member role and automatic removal settings.", "body": { "mode": "raw", "raw": "{\n \"role\": \"admin\",\n \"automaticRemovalDate\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Accepts one or more commands to update member role and automatic removal settings.", "body": { "mode": "raw", "raw": "{\n \"role\": \"admin\",\n \"automaticRemovalDate\": null\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000932\",\n \"resourceType\": \"member\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/members\"\n }\n}" } ] }, { "name": "Remove a member", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Accepts a command to remove an active team member." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Accepts a command to remove an active team member." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000932\",\n \"resourceType\": \"member\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/members\"\n }\n}" } ] }, { "name": "Retrieve a member profile", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}/profile", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}", "profile" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Returns the member profile fields visible to the token user based on each profile field's visibility setting." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/members/{{memberId}}/profile", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "members", "{{memberId}}", "profile" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "memberId", "value": "{{memberId}}", "description": "Member identifier." } ] }, "description": "Returns the member profile fields visible to the token user based on each profile field's visibility setting." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000932\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"membershipId\": \"00000000-0000-4000-8000-000000000933\",\n \"userId\": \"00000000-0000-4000-8000-000000000932\",\n \"memberName\": \"Crew Member\",\n \"givenName\": \"Crew\",\n \"familyName\": \"Member\",\n \"memberEmail\": \"crew@example.com\",\n \"memberPicture\": \"https://assets.roadops.app/public/profiles/crew-member.jpg\",\n \"fields\": {\n \"firstName\": {\n \"value\": \"Crew\",\n \"visibility\": \"org-members\",\n \"updatedBy\": {\n \"actorId\": \"00000000-0000-4000-8000-000000000932\",\n \"actorType\": \"user\"\n },\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"lastName\": {\n \"value\": \"Member\",\n \"visibility\": \"org-members\",\n \"updatedBy\": {\n \"actorId\": \"00000000-0000-4000-8000-000000000932\",\n \"actorType\": \"user\"\n },\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"emergencyContact\": {\n \"value\": {\n \"name\": \"Tour Manager\",\n \"relationship\": \"Manager\",\n \"phone\": \"+1 615-555-0100\",\n \"email\": \"tour.manager@example.com\"\n },\n \"visibility\": \"org-admins\",\n \"updatedBy\": {\n \"actorId\": \"00000000-0000-4000-8000-000000000932\",\n \"actorType\": \"user\"\n },\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"busBunkPreference\": {\n \"value\": {\n \"side\": \"driver-side\",\n \"bunk\": \"top\",\n \"position\": \"front\"\n },\n \"visibility\": \"org-admins\",\n \"updatedBy\": {\n \"actorId\": \"00000000-0000-4000-8000-000000000932\",\n \"actorType\": \"user\"\n },\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"flightSeatingPreference\": {\n \"value\": \"aisle\",\n \"visibility\": \"org-admins\",\n \"updatedBy\": {\n \"actorId\": \"00000000-0000-4000-8000-000000000932\",\n \"actorType\": \"user\"\n },\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"dietaryRestrictions\": {\n \"value\": \"Vegetarian\",\n \"visibility\": \"org-admins\",\n \"updatedBy\": {\n \"actorId\": \"00000000-0000-4000-8000-000000000932\",\n \"actorType\": \"user\"\n },\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n }\n },\n \"version\": 2,\n \"cursor\": 87235\n },\n \"meta\": {\n \"cursor\": 87235\n }\n}" } ] } ] }, { "name": "Travel Parties", "item": [ { "name": "List user groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists user groups for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists user groups for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000941\",\n \"name\": \"Tour Management\",\n \"labelColor\": \"#2E6F40\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a user group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a user group.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000941\",\n \"name\": \"Tour Management\",\n \"labelColor\": \"#2E6F40\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a user group.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000941\",\n \"name\": \"Tour Management\",\n \"labelColor\": \"#2E6F40\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000941\",\n \"resourceType\": \"user_group\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/user-groups/00000000-0000-4000-8000-000000000941\"\n }\n}" } ] }, { "name": "Retrieve a user group", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Returns one user group by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Returns one user group by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000941\",\n \"name\": \"Tour Management\",\n \"labelColor\": \"#2E6F40\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a user group", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Accepts a command to update user group fields.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department Heads\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Accepts a command to update user group fields.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department Heads\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000941\",\n \"resourceType\": \"user_group\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/user-groups/00000000-0000-4000-8000-000000000941\"\n }\n}" } ] }, { "name": "Delete a user group", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Accepts a command to delete a user group.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Group retired.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Accepts a command to delete a user group.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Group retired.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000941\",\n \"resourceType\": \"user_group\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/user-groups/00000000-0000-4000-8000-000000000941\"\n }\n}" } ] }, { "name": "List user group members", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}", "members" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Lists members assigned to a travel party." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}", "members" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Lists members assigned to a travel party." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000942\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"groupId\": \"00000000-0000-4000-8000-000000000941\",\n \"userId\": \"00000000-0000-4000-8000-000000000103\",\n \"memberName\": \"Taylor Jordan\",\n \"givenName\": \"Taylor\",\n \"familyName\": \"Jordan\",\n \"memberEmail\": \"taylor@example.com\",\n \"memberPicture\": \"https://assets.roadops.app/public/profiles/taylor.jpg\",\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87235\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Add a user group member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}", "members" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Accepts a command to add an existing team member to a travel party.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"00000000-0000-4000-8000-000000000103\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}", "members" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." } ] }, "description": "Accepts a command to add an existing team member to a travel party.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"00000000-0000-4000-8000-000000000103\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000942\",\n \"resourceType\": \"user_group_member\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/user-groups/00000000-0000-4000-8000-000000000941/members\"\n }\n}" } ] }, { "name": "Remove a user group member", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}/members/{{userId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}", "members", "{{userId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." }, { "key": "userId", "value": "{{userId}}", "description": "RoadOps user identifier for the member to remove." } ] }, "description": "Accepts a command to remove a member from a travel party." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/user-groups/{{userGroupId}}/members/{{userId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "user-groups", "{{userGroupId}}", "members", "{{userId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "userGroupId", "value": "{{userGroupId}}", "description": "User group identifier." }, { "key": "userId", "value": "{{userId}}", "description": "RoadOps user identifier for the member to remove." } ] }, "description": "Accepts a command to remove a member from a travel party." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000942\",\n \"resourceType\": \"user_group_member\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/user-groups/00000000-0000-4000-8000-000000000941/members\"\n }\n}" } ] } ] } ] }, { "name": "Days", "item": [ { "name": "List days", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days" ], "query": [ { "key": "startDate", "value": "", "description": "Optional inclusive start date filter in YYYY-MM-DD format.", "disabled": true }, { "key": "endDate", "value": "", "description": "Optional inclusive end date filter in YYYY-MM-DD format.", "disabled": true }, { "key": "includeHistorical", "value": "false", "description": "Set to true to include historical days when no startDate or endDate is provided. Defaults to false.", "disabled": false }, { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists day records for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days" ], "query": [ { "key": "startDate", "value": "", "description": "Optional inclusive start date filter in YYYY-MM-DD format.", "disabled": true }, { "key": "endDate", "value": "", "description": "Optional inclusive end date filter in YYYY-MM-DD format.", "disabled": true }, { "key": "includeHistorical", "value": "false", "description": "Set to true to include historical days when no startDate or endDate is provided. Defaults to false.", "disabled": false }, { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists day records for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Nashville\",\n \"date\": \"2026-09-14\",\n \"timezone\": \"America/Chicago\",\n \"location\": \"Nashville, TN\",\n \"color\": \"#2E6F40\",\n \"visibility\": {\n \"groupIds\": [\n \"00000000-0000-4000-8000-000000000701\"\n ],\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n },\n \"latitude\": 36.1627,\n \"longitude\": -86.7816,\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a day", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a day.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Nashville\",\n \"date\": \"2026-09-14\",\n \"timezone\": \"America/Chicago\",\n \"location\": \"Nashville, TN\",\n \"color\": \"#2E6F40\",\n \"visibility\": {\n \"groupIds\": [\n \"00000000-0000-4000-8000-000000000701\"\n ],\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n },\n \"latitude\": 36.1627,\n \"longitude\": -86.7816\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a day.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Nashville\",\n \"date\": \"2026-09-14\",\n \"timezone\": \"America/Chicago\",\n \"location\": \"Nashville, TN\",\n \"color\": \"#2E6F40\",\n \"visibility\": {\n \"groupIds\": [\n \"00000000-0000-4000-8000-000000000701\"\n ],\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n },\n \"latitude\": 36.1627,\n \"longitude\": -86.7816\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000201\",\n \"resourceType\": \"day\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201\"\n }\n}" } ] }, { "name": "Retrieve a day", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Returns a single day record by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Returns a single day record by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Nashville\",\n \"date\": \"2026-09-14\",\n \"timezone\": \"America/Chicago\",\n \"location\": \"Nashville, TN\",\n \"color\": \"#2E6F40\",\n \"visibility\": {\n \"groupIds\": [\n \"00000000-0000-4000-8000-000000000701\"\n ],\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n },\n \"latitude\": 36.1627,\n \"longitude\": -86.7816,\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a day", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to update a day.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"location\": \"Bridgestone Arena\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to update a day.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"location\": \"Bridgestone Arena\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000201\",\n \"resourceType\": \"day\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201\"\n }\n}" } ] }, { "name": "Delete a day", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to delete a day." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to delete a day." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000201\",\n \"resourceType\": \"day\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201\"\n }\n}" } ] }, { "name": "Notes", "item": [ { "name": "List day notes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists notes for a day." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists notes for a day." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000971\",\n \"title\": \"Security\",\n \"body\": \"**Security note**\\n\\nUse the stage-left entrance after 6 PM.\\nBring your badge.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a day note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a day note.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000971\",\n \"title\": \"Security\",\n \"body\": \"**Security note**\\n\\nUse the stage-left entrance after 6 PM.\\nBring your badge.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a day note.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000971\",\n \"title\": \"Security\",\n \"body\": \"**Security note**\\n\\nUse the stage-left entrance after 6 PM.\\nBring your badge.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000971\",\n \"resourceType\": \"day_note\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/notes/00000000-0000-4000-8000-000000000971\"\n }\n}" } ] }, { "name": "Retrieve a day note", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes/{{noteId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes", "{{noteId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "noteId", "value": "{{noteId}}", "description": "Day note identifier." } ] }, "description": "Returns one day note by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes/{{noteId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes", "{{noteId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "noteId", "value": "{{noteId}}", "description": "Day note identifier." } ] }, "description": "Returns one day note by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000971\",\n \"title\": \"Security\",\n \"body\": \"**Security note**\\n\\nUse the stage-left entrance after 6 PM.\\nBring your badge.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a day note", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes/{{noteId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes", "{{noteId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "noteId", "value": "{{noteId}}", "description": "Day note identifier." } ] }, "description": "Accepts a command to update day note fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"body\": \"**Security note**\\n\\nUse the stage-right entrance after 6 PM.\\nBring your badge.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes/{{noteId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes", "{{noteId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "noteId", "value": "{{noteId}}", "description": "Day note identifier." } ] }, "description": "Accepts a command to update day note fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"body\": \"**Security note**\\n\\nUse the stage-right entrance after 6 PM.\\nBring your badge.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000971\",\n \"resourceType\": \"day_note\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/notes/00000000-0000-4000-8000-000000000971\"\n }\n}" } ] }, { "name": "Delete a day note", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes/{{noteId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes", "{{noteId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "noteId", "value": "{{noteId}}", "description": "Day note identifier." } ] }, "description": "Accepts a command to delete a day note.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/notes/{{noteId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "notes", "{{noteId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "noteId", "value": "{{noteId}}", "description": "Day note identifier." } ] }, "description": "Accepts a command to delete a day note.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000971\",\n \"resourceType\": \"day_note\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/notes/00000000-0000-4000-8000-000000000971\"\n }\n}" } ] } ] }, { "name": "Schedule Items", "item": [ { "name": "List schedule items", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists general schedule items, drives, and flights for a day." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists general schedule items, drives, and flights for a day." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000301\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Load in\",\n \"type\": \"general\",\n \"status\": \"confirmed\",\n \"priority\": \"normal\",\n \"startTime\": \"2026-09-14T15:00:00.000Z\",\n \"endTime\": \"2026-09-14T16:00:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"general\",\n \"location\": {\n \"label\": \"Loading dock\"\n }\n },\n \"notes\": \"Stage door is off 5th Avenue.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a general schedule item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a general schedule item. Use `type: \"general\"` with `details.kind: \"general\"`.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000301\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Load in\",\n \"type\": \"general\",\n \"status\": \"confirmed\",\n \"priority\": \"normal\",\n \"startTime\": \"2026-09-14T15:00:00.000Z\",\n \"endTime\": \"2026-09-14T16:00:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"general\",\n \"location\": {\n \"label\": \"Loading dock\"\n }\n },\n \"notes\": \"Stage door is off 5th Avenue.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a general schedule item. Use `type: \"general\"` with `details.kind: \"general\"`.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000301\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Load in\",\n \"type\": \"general\",\n \"status\": \"confirmed\",\n \"priority\": \"normal\",\n \"startTime\": \"2026-09-14T15:00:00.000Z\",\n \"endTime\": \"2026-09-14T16:00:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"general\",\n \"location\": {\n \"label\": \"Loading dock\"\n }\n },\n \"notes\": \"Stage door is off 5th Avenue.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000301\",\n \"resourceType\": \"schedule_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/schedule-items/00000000-0000-4000-8000-000000000301\"\n }\n}" } ] }, { "name": "Create a drive schedule item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a drive schedule item. Use `type: \"drive\"` with `details.kind: \"drive\"` and drive-specific origin, destination, distance, duration, vehicle, and notes fields.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000302\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Hotel to venue\",\n \"type\": \"drive\",\n \"status\": \"confirmed\",\n \"priority\": \"normal\",\n \"startTime\": \"2026-09-14T17:00:00.000Z\",\n \"endTime\": \"2026-09-14T17:25:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"drive\",\n \"origin\": {\n \"label\": \"Hotel\",\n \"address\": \"401 Union St, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"destination\": {\n \"label\": \"Venue\",\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"distanceMiles\": 1.2,\n \"durationMinutes\": 25,\n \"vehicle\": \"Sprinter\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a drive schedule item. Use `type: \"drive\"` with `details.kind: \"drive\"` and drive-specific origin, destination, distance, duration, vehicle, and notes fields.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000302\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Hotel to venue\",\n \"type\": \"drive\",\n \"status\": \"confirmed\",\n \"priority\": \"normal\",\n \"startTime\": \"2026-09-14T17:00:00.000Z\",\n \"endTime\": \"2026-09-14T17:25:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"drive\",\n \"origin\": {\n \"label\": \"Hotel\",\n \"address\": \"401 Union St, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"destination\": {\n \"label\": \"Venue\",\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"distanceMiles\": 1.2,\n \"durationMinutes\": 25,\n \"vehicle\": \"Sprinter\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000302\",\n \"resourceType\": \"schedule_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/schedule-items/00000000-0000-4000-8000-000000000302\"\n }\n}" } ] }, { "name": "Create a flight schedule item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a flight schedule item. Use `type: \"flight\"` with `details.kind: \"flight\"` and flight-specific passenger, confirmation, aircraft, and connection fields.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000303\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Flight to Nashville\",\n \"type\": \"flight\",\n \"status\": \"confirmed\",\n \"priority\": \"high\",\n \"startTime\": \"2026-09-14T13:00:00.000Z\",\n \"endTime\": \"2026-09-14T14:35:00.000Z\",\n \"startTimezone\": \"America/New_York\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"flight\",\n \"flightType\": \"commercial\",\n \"confirmationNumber\": \"ABC123\",\n \"passengers\": [\n \"00000000-0000-4000-8000-000000000401\"\n ],\n \"connections\": [\n {\n \"airline\": \"Delta\",\n \"flightNumber\": \"DL1234\",\n \"origin\": {\n \"code\": \"LGA\",\n \"name\": \"LaGuardia Airport\"\n },\n \"destination\": {\n \"code\": \"BNA\",\n \"name\": \"Nashville International Airport\"\n },\n \"departureTime\": \"2026-09-14T13:00:00.000Z\",\n \"departureTimezone\": \"America/New_York\",\n \"arrivalTime\": \"2026-09-14T14:35:00.000Z\",\n \"arrivalTimezone\": \"America/Chicago\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create a flight schedule item. Use `type: \"flight\"` with `details.kind: \"flight\"` and flight-specific passenger, confirmation, aircraft, and connection fields.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000303\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Flight to Nashville\",\n \"type\": \"flight\",\n \"status\": \"confirmed\",\n \"priority\": \"high\",\n \"startTime\": \"2026-09-14T13:00:00.000Z\",\n \"endTime\": \"2026-09-14T14:35:00.000Z\",\n \"startTimezone\": \"America/New_York\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"flight\",\n \"flightType\": \"commercial\",\n \"confirmationNumber\": \"ABC123\",\n \"passengers\": [\n \"00000000-0000-4000-8000-000000000401\"\n ],\n \"connections\": [\n {\n \"airline\": \"Delta\",\n \"flightNumber\": \"DL1234\",\n \"origin\": {\n \"code\": \"LGA\",\n \"name\": \"LaGuardia Airport\"\n },\n \"destination\": {\n \"code\": \"BNA\",\n \"name\": \"Nashville International Airport\"\n },\n \"departureTime\": \"2026-09-14T13:00:00.000Z\",\n \"departureTimezone\": \"America/New_York\",\n \"arrivalTime\": \"2026-09-14T14:35:00.000Z\",\n \"arrivalTimezone\": \"America/Chicago\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000303\",\n \"resourceType\": \"schedule_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/schedule-items/00000000-0000-4000-8000-000000000303\"\n }\n}" } ] }, { "name": "Retrieve a schedule item", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Returns one schedule item, drive, or flight by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Returns one schedule item, drive, or flight by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000301\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"name\": \"Load in\",\n \"type\": \"general\",\n \"status\": \"confirmed\",\n \"priority\": \"normal\",\n \"startTime\": \"2026-09-14T15:00:00.000Z\",\n \"endTime\": \"2026-09-14T16:00:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\",\n \"details\": {\n \"kind\": \"general\",\n \"location\": {\n \"label\": \"Loading dock\"\n }\n },\n \"notes\": \"Stage door is off 5th Avenue.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a schedule item", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Accepts a command to update a general schedule item, drive, or flight.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Use stage-left entrance.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Accepts a command to update a general schedule item, drive, or flight.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Use stage-left entrance.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000301\",\n \"resourceType\": \"schedule_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/schedule-items/00000000-0000-4000-8000-000000000301\"\n }\n}" } ] }, { "name": "Delete a schedule item", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Accepts a command to delete a schedule item, drive, or flight." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Accepts a command to delete a schedule item, drive, or flight." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000301\",\n \"resourceType\": \"schedule_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/schedule-items/00000000-0000-4000-8000-000000000301\"\n }\n}" } ] }, { "name": "Reschedule a schedule item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}/reschedule", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}", "reschedule" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Moves a schedule item to new start and end times. Use this endpoint specifically for time changes rather than general schedule item edits. If the move changes an item occurring within a user's 24h or 48h schedule notice window, RoadOps sends push notifications to users who have schedule notifications enabled.", "body": { "mode": "raw", "raw": "{\n \"startTime\": \"2026-09-14T16:00:00.000Z\",\n \"endTime\": \"2026-09-14T17:00:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/schedule-items/{{scheduleItemId}}/reschedule", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "schedule-items", "{{scheduleItemId}}", "reschedule" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "scheduleItemId", "value": "{{scheduleItemId}}", "description": "Schedule item identifier." } ] }, "description": "Moves a schedule item to new start and end times. Use this endpoint specifically for time changes rather than general schedule item edits. If the move changes an item occurring within a user's 24h or 48h schedule notice window, RoadOps sends push notifications to users who have schedule notifications enabled.", "body": { "mode": "raw", "raw": "{\n \"startTime\": \"2026-09-14T16:00:00.000Z\",\n \"endTime\": \"2026-09-14T17:00:00.000Z\",\n \"startTimezone\": \"America/Chicago\",\n \"endTimezone\": \"America/Chicago\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000301\",\n \"resourceType\": \"schedule_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/schedule-items/00000000-0000-4000-8000-000000000301\"\n }\n}" } ] } ] }, { "name": "Events", "item": [ { "name": "List events", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists event records for a day." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists event records for a day." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000601\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"venueId\": \"00000000-0000-4000-8000-000000000701\",\n \"name\": \"Show\",\n \"notes\": \"Main performance event.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"contacts\": [],\n \"laborCalls\": [],\n \"guestList\": {\n \"enabled\": true,\n \"ticketsAllotted\": null,\n \"cutoffAt\": null,\n \"willCallPickupInstructions\": null,\n \"seats\": [],\n \"ticketTypeAllotments\": []\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create an event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create an event for a day.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000601\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"venueId\": \"00000000-0000-4000-8000-000000000701\",\n \"name\": \"Show\",\n \"notes\": \"Main performance event.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Accepts a command to create an event for a day.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000601\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"venueId\": \"00000000-0000-4000-8000-000000000701\",\n \"name\": \"Show\",\n \"notes\": \"Main performance event.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000601\",\n \"resourceType\": \"event\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601\"\n }\n}" } ] }, { "name": "Retrieve an event", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Returns one event record by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Returns one event record by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000601\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"venueId\": \"00000000-0000-4000-8000-000000000701\",\n \"name\": \"Show\",\n \"notes\": \"Main performance event.\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"contacts\": [],\n \"laborCalls\": [],\n \"guestList\": {\n \"enabled\": true,\n \"ticketsAllotted\": null,\n \"cutoffAt\": null,\n \"willCallPickupInstructions\": null,\n \"seats\": [],\n \"ticketTypeAllotments\": []\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update an event", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to update event fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Doors moved to 7:30 PM.\",\n \"visibility\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to update event fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Doors moved to 7:30 PM.\",\n \"visibility\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000601\",\n \"resourceType\": \"event\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601\"\n }\n}" } ] }, { "name": "Delete an event", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to delete an event." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to delete an event." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000601\",\n \"resourceType\": \"event\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601\"\n }\n}" } ] }, { "name": "Venues", "item": [ { "name": "List venues", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists venue records visible to the token owner for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists venue records visible to the token owner for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000701\",\n \"officialName\": \"Ryman Auditorium\",\n \"displayName\": \"The Ryman\",\n \"previousNames\": [],\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN 37219\",\n \"timezone\": \"America/Chicago\",\n \"capacity\": {\n \"total\": 2362\n },\n \"contacts\": [],\n \"externalRefs\": [],\n \"tags\": [\n \"theater\"\n ],\n \"notes\": \"Historic venue in downtown Nashville.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"metadata\": {\n \"status\": \"active\",\n \"visibility\": \"org_only\",\n \"source\": \"org\",\n \"dataMode\": \"org_local\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a venue", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a venue for a team.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000701\",\n \"officialName\": \"Ryman Auditorium\",\n \"displayName\": \"The Ryman\",\n \"previousNames\": [],\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN 37219\",\n \"timezone\": \"America/Chicago\",\n \"capacity\": {\n \"total\": 2362\n },\n \"contacts\": [],\n \"externalRefs\": [],\n \"tags\": [\n \"theater\"\n ],\n \"notes\": \"Historic venue in downtown Nashville.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a venue for a team.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000701\",\n \"officialName\": \"Ryman Auditorium\",\n \"displayName\": \"The Ryman\",\n \"previousNames\": [],\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN 37219\",\n \"timezone\": \"America/Chicago\",\n \"capacity\": {\n \"total\": 2362\n },\n \"contacts\": [],\n \"externalRefs\": [],\n \"tags\": [\n \"theater\"\n ],\n \"notes\": \"Historic venue in downtown Nashville.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000701\",\n \"resourceType\": \"venue\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/venues/00000000-0000-4000-8000-000000000701\"\n }\n}" } ] }, { "name": "Search venues", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/search", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "search" ], "query": [ { "key": "query", "value": "", "description": "Local venue search query. Matches the team's venue search index.", "disabled": false }, { "key": "limit", "value": "", "description": "Maximum number of local venue records to return. Defaults to 10 and is capped at 20.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Searches the team's local venue records." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/search", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "search" ], "query": [ { "key": "query", "value": "", "description": "Local venue search query. Matches the team's venue search index.", "disabled": false }, { "key": "limit", "value": "", "description": "Maximum number of local venue records to return. Defaults to 10 and is capped at 20.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Searches the team's local venue records." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000701\",\n \"officialName\": \"Ryman Auditorium\",\n \"displayName\": \"The Ryman\",\n \"previousNames\": [],\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN 37219\",\n \"timezone\": \"America/Chicago\",\n \"capacity\": {\n \"total\": 2362\n },\n \"contacts\": [],\n \"externalRefs\": [],\n \"tags\": [\n \"theater\"\n ],\n \"notes\": \"Historic venue in downtown Nashville.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"metadata\": {\n \"status\": \"active\",\n \"visibility\": \"org_only\",\n \"source\": \"org\",\n \"dataMode\": \"org_local\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"meta\": {\n \"query\": \"ryman\",\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Retrieve a venue", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/{{venueId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "{{venueId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "venueId", "value": "{{venueId}}", "description": "Venue identifier." } ] }, "description": "Returns one venue record by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/{{venueId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "{{venueId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "venueId", "value": "{{venueId}}", "description": "Venue identifier." } ] }, "description": "Returns one venue record by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000701\",\n \"officialName\": \"Ryman Auditorium\",\n \"displayName\": \"The Ryman\",\n \"previousNames\": [],\n \"address\": \"116 Rep. John Lewis Way N, Nashville, TN 37219\",\n \"timezone\": \"America/Chicago\",\n \"capacity\": {\n \"total\": 2362\n },\n \"contacts\": [],\n \"externalRefs\": [],\n \"tags\": [\n \"theater\"\n ],\n \"notes\": \"Historic venue in downtown Nashville.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"metadata\": {\n \"status\": \"active\",\n \"visibility\": \"org_only\",\n \"source\": \"org\",\n \"dataMode\": \"org_local\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\"\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a venue", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/{{venueId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "{{venueId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "venueId", "value": "{{venueId}}", "description": "Venue identifier." } ] }, "description": "Accepts a command to update venue profile fields.", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"displayName\": \"Ryman Auditorium\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/{{venueId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "{{venueId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "venueId", "value": "{{venueId}}", "description": "Venue identifier." } ] }, "description": "Accepts a command to update venue profile fields.", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"displayName\": \"Ryman Auditorium\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000701\",\n \"resourceType\": \"venue\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/venues/00000000-0000-4000-8000-000000000701\"\n }\n}" } ] }, { "name": "Delete a venue", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/{{venueId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "{{venueId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "venueId", "value": "{{venueId}}", "description": "Venue identifier." } ] }, "description": "Accepts a command to delete a venue.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Duplicate venue record.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/venues/{{venueId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "venues", "{{venueId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "venueId", "value": "{{venueId}}", "description": "Venue identifier." } ] }, "description": "Accepts a command to delete a venue.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Duplicate venue record.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000701\",\n \"resourceType\": \"venue\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/venues/00000000-0000-4000-8000-000000000701\"\n }\n}" } ] } ] }, { "name": "Guest Requests", "item": [ { "name": "List guest requests", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Lists guest request records for an event." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Lists guest request records for an event." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000801\",\n \"guestFirstName\": \"Jamie\",\n \"guestLastName\": \"Lee\",\n \"totalTickets\": 2,\n \"status\": \"pending\",\n \"pickupLocation\": \"will_call\",\n \"attendeeContactEmail\": \"jamie@example.com\",\n \"notes\": \"Guest of tour manager.\",\n \"ticketType\": {\n \"ticketTypeId\": \"00000000-0000-4000-8000-000000000961\",\n \"nameAtRequest\": \"Reserved\",\n \"abbreviationAtRequest\": \"RSV\"\n },\n \"passes\": [\n {\n \"passTypeId\": \"00000000-0000-4000-8000-000000000951\",\n \"nameAtRequest\": \"All Access\",\n \"abbreviationAtRequest\": \"AA\",\n \"quantity\": 2\n }\n ],\n \"assignedSeats\": [],\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"eventId\": \"00000000-0000-4000-8000-000000000601\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdByName\": \"Jamie Lee\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a guest request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to create a guest request for an event.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000801\",\n \"guestFirstName\": \"Jamie\",\n \"guestLastName\": \"Lee\",\n \"totalTickets\": 2,\n \"status\": \"pending\",\n \"pickupLocation\": \"will_call\",\n \"attendeeContactEmail\": \"jamie@example.com\",\n \"notes\": \"Guest of tour manager.\",\n \"ticketType\": {\n \"ticketTypeId\": \"00000000-0000-4000-8000-000000000961\"\n },\n \"passes\": [\n {\n \"passTypeId\": \"00000000-0000-4000-8000-000000000951\",\n \"quantity\": 2\n }\n ],\n \"assignedSeats\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to create a guest request for an event.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000801\",\n \"guestFirstName\": \"Jamie\",\n \"guestLastName\": \"Lee\",\n \"totalTickets\": 2,\n \"status\": \"pending\",\n \"pickupLocation\": \"will_call\",\n \"attendeeContactEmail\": \"jamie@example.com\",\n \"notes\": \"Guest of tour manager.\",\n \"ticketType\": {\n \"ticketTypeId\": \"00000000-0000-4000-8000-000000000961\"\n },\n \"passes\": [\n {\n \"passTypeId\": \"00000000-0000-4000-8000-000000000951\",\n \"quantity\": 2\n }\n ],\n \"assignedSeats\": []\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000801\",\n \"resourceType\": \"guest_request\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601/guest-requests/00000000-0000-4000-8000-000000000801\"\n }\n}" } ] }, { "name": "Retrieve a guest request", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests/{{guestRequestId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests", "{{guestRequestId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "guestRequestId", "value": "{{guestRequestId}}", "description": "Guest request identifier." } ] }, "description": "Returns one guest request record by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests/{{guestRequestId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests", "{{guestRequestId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "guestRequestId", "value": "{{guestRequestId}}", "description": "Guest request identifier." } ] }, "description": "Returns one guest request record by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000801\",\n \"guestFirstName\": \"Jamie\",\n \"guestLastName\": \"Lee\",\n \"totalTickets\": 2,\n \"status\": \"pending\",\n \"pickupLocation\": \"will_call\",\n \"attendeeContactEmail\": \"jamie@example.com\",\n \"notes\": \"Guest of tour manager.\",\n \"ticketType\": {\n \"ticketTypeId\": \"00000000-0000-4000-8000-000000000961\",\n \"nameAtRequest\": \"Reserved\",\n \"abbreviationAtRequest\": \"RSV\"\n },\n \"passes\": [\n {\n \"passTypeId\": \"00000000-0000-4000-8000-000000000951\",\n \"nameAtRequest\": \"All Access\",\n \"abbreviationAtRequest\": \"AA\",\n \"quantity\": 2\n }\n ],\n \"assignedSeats\": [],\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"eventId\": \"00000000-0000-4000-8000-000000000601\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdByName\": \"Jamie Lee\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a guest request", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests/{{guestRequestId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests", "{{guestRequestId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "guestRequestId", "value": "{{guestRequestId}}", "description": "Guest request identifier." } ] }, "description": "Accepts a command to update guest request fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Add plus-one after approval.\",\n \"ticketType\": {\n \"ticketTypeId\": \"00000000-0000-4000-8000-000000000961\"\n },\n \"passes\": [\n {\n \"passTypeId\": \"00000000-0000-4000-8000-000000000951\",\n \"quantity\": 2\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests/{{guestRequestId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests", "{{guestRequestId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "guestRequestId", "value": "{{guestRequestId}}", "description": "Guest request identifier." } ] }, "description": "Accepts a command to update guest request fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Add plus-one after approval.\",\n \"ticketType\": {\n \"ticketTypeId\": \"00000000-0000-4000-8000-000000000961\"\n },\n \"passes\": [\n {\n \"passTypeId\": \"00000000-0000-4000-8000-000000000951\",\n \"quantity\": 2\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000801\",\n \"resourceType\": \"guest_request\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601/guest-requests/00000000-0000-4000-8000-000000000801\"\n }\n}" } ] }, { "name": "Delete a guest request", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests/{{guestRequestId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests", "{{guestRequestId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "guestRequestId", "value": "{{guestRequestId}}", "description": "Guest request identifier." } ] }, "description": "Accepts a command to delete a guest request." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/guest-requests/{{guestRequestId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "guest-requests", "{{guestRequestId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "guestRequestId", "value": "{{guestRequestId}}", "description": "Guest request identifier." } ] }, "description": "Accepts a command to delete a guest request." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000801\",\n \"resourceType\": \"guest_request\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601/guest-requests/00000000-0000-4000-8000-000000000801\"\n }\n}" } ] }, { "name": "Pass Types", "item": [ { "name": "List pass types", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists pass types for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists pass types for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000951\",\n \"name\": \"All Access\",\n \"abbreviation\": \"AA\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"kind\": \"pass\",\n \"isDeleted\": false,\n \"isArchived\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a pass type", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a pass type.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000951\",\n \"name\": \"All Access\",\n \"abbreviation\": \"AA\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a pass type.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000951\",\n \"name\": \"All Access\",\n \"abbreviation\": \"AA\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000951\",\n \"resourceType\": \"pass_type\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/pass-types/00000000-0000-4000-8000-000000000951\"\n }\n}" } ] }, { "name": "Retrieve a pass type", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types/{{passTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types", "{{passTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "passTypeId", "value": "{{passTypeId}}", "description": "Pass type identifier." } ] }, "description": "Returns one pass type by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types/{{passTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types", "{{passTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "passTypeId", "value": "{{passTypeId}}", "description": "Pass type identifier." } ] }, "description": "Returns one pass type by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000951\",\n \"name\": \"All Access\",\n \"abbreviation\": \"AA\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"kind\": \"pass\",\n \"isDeleted\": false,\n \"isArchived\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a pass type", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types/{{passTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types", "{{passTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "passTypeId", "value": "{{passTypeId}}", "description": "Pass type identifier." } ] }, "description": "Accepts a command to update pass type fields.", "body": { "mode": "raw", "raw": "{\n \"abbreviation\": \"ALL\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types/{{passTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types", "{{passTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "passTypeId", "value": "{{passTypeId}}", "description": "Pass type identifier." } ] }, "description": "Accepts a command to update pass type fields.", "body": { "mode": "raw", "raw": "{\n \"abbreviation\": \"ALL\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000951\",\n \"resourceType\": \"pass_type\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/pass-types/00000000-0000-4000-8000-000000000951\"\n }\n}" } ] }, { "name": "Delete a pass type", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types/{{passTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types", "{{passTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "passTypeId", "value": "{{passTypeId}}", "description": "Pass type identifier." } ] }, "description": "Accepts a command to delete a pass type.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/pass-types/{{passTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "pass-types", "{{passTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "passTypeId", "value": "{{passTypeId}}", "description": "Pass type identifier." } ] }, "description": "Accepts a command to delete a pass type.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000951\",\n \"resourceType\": \"pass_type\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/pass-types/00000000-0000-4000-8000-000000000951\"\n }\n}" } ] } ] }, { "name": "Ticket Types", "item": [ { "name": "List ticket types", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists ticket types for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists ticket types for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000961\",\n \"name\": \"Reserved\",\n \"abbreviation\": \"RSV\",\n \"isDefault\": true,\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"kind\": \"ticket\",\n \"isDeleted\": false,\n \"isArchived\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a ticket type", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a ticket type.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000961\",\n \"name\": \"Reserved\",\n \"abbreviation\": \"RSV\",\n \"isDefault\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a ticket type.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000961\",\n \"name\": \"Reserved\",\n \"abbreviation\": \"RSV\",\n \"isDefault\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000961\",\n \"resourceType\": \"ticket_type\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/ticket-types/00000000-0000-4000-8000-000000000961\"\n }\n}" } ] }, { "name": "Retrieve a ticket type", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types/{{ticketTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types", "{{ticketTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "ticketTypeId", "value": "{{ticketTypeId}}", "description": "Ticket type identifier." } ] }, "description": "Returns one ticket type by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types/{{ticketTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types", "{{ticketTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "ticketTypeId", "value": "{{ticketTypeId}}", "description": "Ticket type identifier." } ] }, "description": "Returns one ticket type by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000961\",\n \"name\": \"Reserved\",\n \"abbreviation\": \"RSV\",\n \"isDefault\": true,\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"kind\": \"ticket\",\n \"isDeleted\": false,\n \"isArchived\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a ticket type", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types/{{ticketTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types", "{{ticketTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "ticketTypeId", "value": "{{ticketTypeId}}", "description": "Ticket type identifier." } ] }, "description": "Accepts a command to update ticket type fields.", "body": { "mode": "raw", "raw": "{\n \"abbreviation\": \"RES\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types/{{ticketTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types", "{{ticketTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "ticketTypeId", "value": "{{ticketTypeId}}", "description": "Ticket type identifier." } ] }, "description": "Accepts a command to update ticket type fields.", "body": { "mode": "raw", "raw": "{\n \"abbreviation\": \"RES\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000961\",\n \"resourceType\": \"ticket_type\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/ticket-types/00000000-0000-4000-8000-000000000961\"\n }\n}" } ] }, { "name": "Archive a ticket type", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types/{{ticketTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types", "{{ticketTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "ticketTypeId", "value": "{{ticketTypeId}}", "description": "Ticket type identifier." } ] }, "description": "Accepts a command to archive a ticket type.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/ticket-types/{{ticketTypeId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "ticket-types", "{{ticketTypeId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "ticketTypeId", "value": "{{ticketTypeId}}", "description": "Ticket type identifier." } ] }, "description": "Accepts a command to archive a ticket type.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000961\",\n \"resourceType\": \"ticket_type\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/ticket-types/00000000-0000-4000-8000-000000000961\"\n }\n}" } ] } ] } ] }, { "name": "Set Lists", "item": [ { "name": "List set lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Lists set list records for an event." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Lists set list records for an event." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000901\",\n \"title\": \"Main set\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"items\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000902\",\n \"type\": \"libraryItem\",\n \"setListItemId\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\"\n },\n {\n \"id\": \"00000000-0000-4000-8000-000000000903\",\n \"type\": \"break\",\n \"title\": \"Intermission\",\n \"durationSeconds\": 900\n }\n ],\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"eventId\": \"00000000-0000-4000-8000-000000000601\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a set list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to create a set list for an event.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000901\",\n \"title\": \"Main set\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"items\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000902\",\n \"type\": \"libraryItem\",\n \"setListItemId\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\"\n },\n {\n \"id\": \"00000000-0000-4000-8000-000000000903\",\n \"type\": \"break\",\n \"title\": \"Intermission\",\n \"durationSeconds\": 900\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." } ] }, "description": "Accepts a command to create a set list for an event.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000901\",\n \"title\": \"Main set\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"items\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000902\",\n \"type\": \"libraryItem\",\n \"setListItemId\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\"\n },\n {\n \"id\": \"00000000-0000-4000-8000-000000000903\",\n \"type\": \"break\",\n \"title\": \"Intermission\",\n \"durationSeconds\": 900\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000901\",\n \"resourceType\": \"set_list\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601/set-lists/00000000-0000-4000-8000-000000000901\"\n }\n}" } ] }, { "name": "Retrieve a set list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists/{{setListId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists", "{{setListId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "setListId", "value": "{{setListId}}", "description": "Set list identifier." } ] }, "description": "Returns one set list record by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists/{{setListId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists", "{{setListId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "setListId", "value": "{{setListId}}", "description": "Set list identifier." } ] }, "description": "Returns one set list record by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000901\",\n \"title\": \"Main set\",\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000101\"\n ]\n },\n \"items\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000902\",\n \"type\": \"libraryItem\",\n \"setListItemId\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\"\n },\n {\n \"id\": \"00000000-0000-4000-8000-000000000903\",\n \"type\": \"break\",\n \"title\": \"Intermission\",\n \"durationSeconds\": 900\n }\n ],\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"eventId\": \"00000000-0000-4000-8000-000000000601\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a set list", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists/{{setListId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists", "{{setListId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "setListId", "value": "{{setListId}}", "description": "Set list identifier." } ] }, "description": "Accepts a command to update set list fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"title\": \"Encore set\",\n \"visibility\": null,\n \"items\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000904\",\n \"type\": \"libraryItem\",\n \"setListItemId\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Encore Opener\"\n },\n {\n \"id\": \"00000000-0000-4000-8000-000000000905\",\n \"type\": \"break\",\n \"title\": \"Band changeover\",\n \"durationSeconds\": 300\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists/{{setListId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists", "{{setListId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "setListId", "value": "{{setListId}}", "description": "Set list identifier." } ] }, "description": "Accepts a command to update set list fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"title\": \"Encore set\",\n \"visibility\": null,\n \"items\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000904\",\n \"type\": \"libraryItem\",\n \"setListItemId\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Encore Opener\"\n },\n {\n \"id\": \"00000000-0000-4000-8000-000000000905\",\n \"type\": \"break\",\n \"title\": \"Band changeover\",\n \"durationSeconds\": 300\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000901\",\n \"resourceType\": \"set_list\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601/set-lists/00000000-0000-4000-8000-000000000901\"\n }\n}" } ] }, { "name": "Delete a set list", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists/{{setListId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists", "{{setListId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "setListId", "value": "{{setListId}}", "description": "Set list identifier." } ] }, "description": "Accepts a command to delete a set list." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/events/{{eventId}}/set-lists/{{setListId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "events", "{{eventId}}", "set-lists", "{{setListId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "eventId", "value": "{{eventId}}", "description": "Event identifier." }, { "key": "setListId", "value": "{{setListId}}", "description": "Set list identifier." } ] }, "description": "Accepts a command to delete a set list." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000901\",\n \"resourceType\": \"set_list\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/events/00000000-0000-4000-8000-000000000601/set-lists/00000000-0000-4000-8000-000000000901\"\n }\n}" } ] }, { "name": "Set List Items", "item": [ { "name": "List set list items", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists reusable set list library items for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists reusable set list library items for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isRetired\": false,\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create a set list item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a reusable set list library item.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a reusable set list library item.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000911\",\n \"resourceType\": \"set_list_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/set-list-items/00000000-0000-4000-8000-000000000911\"\n }\n}" } ] }, { "name": "Retrieve a set list item", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Returns one reusable set list library item by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Returns one reusable set list library item by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000911\",\n \"title\": \"Opening Song\",\n \"durationSeconds\": 240,\n \"printTitle\": \"Opening Song\",\n \"notes\": \"Start with click track.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isRetired\": false,\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a set list item", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to update reusable set list library item fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Move later in the set.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to update reusable set list library item fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"notes\": \"Move later in the set.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000911\",\n \"resourceType\": \"set_list_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/set-list-items/00000000-0000-4000-8000-000000000911\"\n }\n}" } ] }, { "name": "Delete a set list item", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to delete a reusable set list library item." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to delete a reusable set list library item." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000911\",\n \"resourceType\": \"set_list_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/set-list-items/00000000-0000-4000-8000-000000000911\"\n }\n}" } ] }, { "name": "Retire a set list item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}/retire", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}", "retire" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to retire a reusable set list library item without deleting it.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}/retire", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}", "retire" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to retire a reusable set list library item without deleting it.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000911\",\n \"resourceType\": \"set_list_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/set-list-items/00000000-0000-4000-8000-000000000911\"\n }\n}" } ] }, { "name": "Restore a set list item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}/restore", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}", "restore" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to restore a retired reusable set list library item.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/set-list-items/{{setListItemId}}/restore", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "set-list-items", "{{setListItemId}}", "restore" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "setListItemId", "value": "{{setListItemId}}", "description": "Set list item identifier." } ] }, "description": "Accepts a command to restore a retired reusable set list library item.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000911\",\n \"resourceType\": \"set_list_item\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/set-list-items/00000000-0000-4000-8000-000000000911\"\n }\n}" } ] } ] } ] } ] }, { "name": "Lodging", "item": [ { "name": "List lodging", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging" ], "query": [ { "key": "date", "value": "", "description": "Optional local date filter in YYYY-MM-DD format. Returns lodging records whose local check-in/check-out date range overlaps this date.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists lodging records for a team." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging" ], "query": [ { "key": "date", "value": "", "description": "Optional local date filter in YYYY-MM-DD format. Returns lodging records whose local check-in/check-out date range overlaps this date.", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Lists lodging records for a team." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000921\",\n \"name\": \"Downtown Hotel\",\n \"label\": \"Drivers\",\n \"sortOrder\": 1,\n \"confirmationNumber\": \"HTL123\",\n \"location\": {\n \"name\": \"Downtown Hotel\",\n \"address\": \"401 Union St, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"checkInTime\": \"2026-09-14T20:00:00.000Z\",\n \"checkOutTime\": \"2026-09-15T15:00:00.000Z\",\n \"contacts\": [],\n \"roomCount\": 2,\n \"rooms\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000922\",\n \"roomType\": \"King\",\n \"confirmationNumber\": \"HTL123-1\",\n \"checkInDate\": \"2026-09-14\",\n \"checkOutDate\": \"2026-09-15\",\n \"occupants\": \"Tour manager\"\n }\n ],\n \"notes\": \"Late checkout requested.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Create lodging", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a lodging record.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000921\",\n \"name\": \"Downtown Hotel\",\n \"label\": \"Drivers\",\n \"sortOrder\": 1,\n \"confirmationNumber\": \"HTL123\",\n \"location\": {\n \"name\": \"Downtown Hotel\",\n \"address\": \"401 Union St, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"checkInTime\": \"2026-09-14T20:00:00.000Z\",\n \"checkOutTime\": \"2026-09-15T15:00:00.000Z\",\n \"contacts\": [],\n \"roomCount\": 2,\n \"rooms\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000922\",\n \"roomType\": \"King\",\n \"confirmationNumber\": \"HTL123-1\",\n \"checkInDate\": \"2026-09-14\",\n \"checkOutDate\": \"2026-09-15\",\n \"occupants\": \"Tour manager\"\n }\n ],\n \"notes\": \"Late checkout requested.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." } ] }, "description": "Accepts a command to create a lodging record.", "body": { "mode": "raw", "raw": "{\n \"id\": \"00000000-0000-4000-8000-000000000921\",\n \"name\": \"Downtown Hotel\",\n \"label\": \"Drivers\",\n \"sortOrder\": 1,\n \"confirmationNumber\": \"HTL123\",\n \"location\": {\n \"name\": \"Downtown Hotel\",\n \"address\": \"401 Union St, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"checkInTime\": \"2026-09-14T20:00:00.000Z\",\n \"checkOutTime\": \"2026-09-15T15:00:00.000Z\",\n \"contacts\": [],\n \"roomCount\": 2,\n \"rooms\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000922\",\n \"roomType\": \"King\",\n \"confirmationNumber\": \"HTL123-1\",\n \"checkInDate\": \"2026-09-14\",\n \"checkOutDate\": \"2026-09-15\",\n \"occupants\": \"Tour manager\"\n }\n ],\n \"notes\": \"Late checkout requested.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000921\",\n \"resourceType\": \"lodging\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/lodging/00000000-0000-4000-8000-000000000921\"\n }\n}" } ] }, { "name": "Retrieve lodging", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging/{{lodgingId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging", "{{lodgingId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "lodgingId", "value": "{{lodgingId}}", "description": "Lodging identifier." } ] }, "description": "Returns one lodging record by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging/{{lodgingId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging", "{{lodgingId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "lodgingId", "value": "{{lodgingId}}", "description": "Lodging identifier." } ] }, "description": "Returns one lodging record by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000921\",\n \"name\": \"Downtown Hotel\",\n \"label\": \"Drivers\",\n \"sortOrder\": 1,\n \"confirmationNumber\": \"HTL123\",\n \"location\": {\n \"name\": \"Downtown Hotel\",\n \"address\": \"401 Union St, Nashville, TN\",\n \"timezone\": \"America/Chicago\"\n },\n \"checkInTime\": \"2026-09-14T20:00:00.000Z\",\n \"checkOutTime\": \"2026-09-15T15:00:00.000Z\",\n \"contacts\": [],\n \"roomCount\": 2,\n \"rooms\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000922\",\n \"roomType\": \"King\",\n \"confirmationNumber\": \"HTL123-1\",\n \"checkInDate\": \"2026-09-14\",\n \"checkOutDate\": \"2026-09-15\",\n \"occupants\": \"Tour manager\"\n }\n ],\n \"notes\": \"Late checkout requested.\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"isDeleted\": false,\n \"createdBy\": \"00000000-0000-4000-8000-000000000101\",\n \"createdAt\": \"2026-09-01T12:00:00.000Z\",\n \"updatedBy\": \"00000000-0000-4000-8000-000000000101\",\n \"updatedAt\": \"2026-09-01T12:00:00.000Z\",\n \"version\": 1,\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update lodging", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging/{{lodgingId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging", "{{lodgingId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "lodgingId", "value": "{{lodgingId}}", "description": "Lodging identifier." } ] }, "description": "Accepts a command to update lodging fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"label\": \"Drivers\",\n \"sortOrder\": 2,\n \"notes\": \"Late checkout confirmed.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging/{{lodgingId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging", "{{lodgingId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "lodgingId", "value": "{{lodgingId}}", "description": "Lodging identifier." } ] }, "description": "Accepts a command to update lodging fields.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"label\": \"Drivers\",\n \"sortOrder\": 2,\n \"notes\": \"Late checkout confirmed.\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000921\",\n \"resourceType\": \"lodging\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/lodging/00000000-0000-4000-8000-000000000921\"\n }\n}" } ] }, { "name": "Delete lodging", "request": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging/{{lodgingId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging", "{{lodgingId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "lodgingId", "value": "{{lodgingId}}", "description": "Lodging identifier." } ] }, "description": "Accepts a command to delete a lodging record." }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/lodging/{{lodgingId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "lodging", "{{lodgingId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "lodgingId", "value": "{{lodgingId}}", "description": "Lodging identifier." } ] }, "description": "Accepts a command to delete a lodging record." }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000921\",\n \"resourceType\": \"lodging\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/lodging/00000000-0000-4000-8000-000000000921\"\n }\n}" } ] } ] }, { "name": "Files", "item": [ { "name": "List day files", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists files attached to a day." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of records to return. Defaults to 50 and is capped at 200.", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor returned by page.nextCursor from the previous list response.", "disabled": true } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Lists files attached to a day." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"00000000-0000-4000-8000-000000000901\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"fileName\": \"Security map.pdf\",\n \"contentType\": \"application/pdf\",\n \"sizeBytes\": 245760,\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"createdAt\": \"2026-09-14T14:00:00.000Z\",\n \"createdBy\": \"00000000-0000-4000-8000-000000000100\",\n \"cursor\": 87234\n }\n ],\n \"page\": {\n \"limit\": 50,\n \"nextCursor\": null\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Upload a day file", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Uploads one file attachment for a day and accepts a command to create the day file record. Send the request as multipart/form-data with the binary file in the file field. Optional text fields are id, fileName, and visibility. Direct uploads are capped at 10 MB.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "Select the file to upload." }, { "key": "fileName", "type": "text", "value": "Security map.pdf" }, { "key": "visibility", "type": "text", "value": "{\"userIds\":[\"00000000-0000-4000-8000-000000000702\"]}" } ] } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." } ] }, "description": "Uploads one file attachment for a day and accepts a command to create the day file record. Send the request as multipart/form-data with the binary file in the file field. Optional text fields are id, fileName, and visibility. Direct uploads are capped at 10 MB.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "Select the file to upload." }, { "key": "fileName", "type": "text", "value": "Security map.pdf" }, { "key": "visibility", "type": "text", "value": "{\"userIds\":[\"00000000-0000-4000-8000-000000000702\"]}" } ] } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000901\",\n \"resourceType\": \"day_file\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/files/00000000-0000-4000-8000-000000000901\"\n }\n}" } ] }, { "name": "Retrieve a day file", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Returns one day file by ID." }, "response": [ { "name": "Response 200", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Returns one day file by ID." }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"00000000-0000-4000-8000-000000000901\",\n \"orgId\": \"00000000-0000-4000-8000-000000000100\",\n \"dayId\": \"00000000-0000-4000-8000-000000000201\",\n \"fileName\": \"Security map.pdf\",\n \"contentType\": \"application/pdf\",\n \"sizeBytes\": 245760,\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n },\n \"isDeleted\": false,\n \"version\": 1,\n \"createdAt\": \"2026-09-14T14:00:00.000Z\",\n \"createdBy\": \"00000000-0000-4000-8000-000000000100\",\n \"cursor\": 87234\n },\n \"meta\": {\n \"cursor\": 87234\n }\n}" } ] }, { "name": "Update a day file", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Accepts a command to update day file metadata. File replacement is not supported; delete and upload a new file instead.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Accepts a command to update day file metadata. File replacement is not supported; delete and upload a new file instead.", "body": { "mode": "raw", "raw": "{\n \"updates\": {\n \"visibility\": {\n \"userIds\": [\n \"00000000-0000-4000-8000-000000000702\"\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000901\",\n \"resourceType\": \"day_file\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/files/00000000-0000-4000-8000-000000000901\"\n }\n}" } ] }, { "name": "Delete a day file", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Accepts a command to delete a day file and remove the stored object.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Response 202", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Accepts a command to delete a day file and remove the stored object.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"commandId\": \"00000000-0000-4000-8000-000000000010\",\n \"resourceId\": \"00000000-0000-4000-8000-000000000901\",\n \"resourceType\": \"day_file\",\n \"status\": \"applied\",\n \"aggregateVersion\": 2,\n \"cursor\": 87234,\n \"links\": {\n \"refetch\": \"/v1/teams/00000000-0000-4000-8000-000000000100/days/00000000-0000-4000-8000-000000000201/files/00000000-0000-4000-8000-000000000901\"\n }\n}" } ] }, { "name": "Download a day file", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teams/{{teamId}}/days/{{dayId}}/files/{{fileId}}/download", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{{teamId}}", "days", "{{dayId}}", "files", "{{fileId}}", "download" ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Team identifier." }, { "key": "dayId", "value": "{{dayId}}", "description": "Day identifier." }, { "key": "fileId", "value": "{{fileId}}", "description": "Day file identifier." } ] }, "description": "Redirects to a short-lived signed URL that downloads the file directly. Follow the redirect or read the Location response header." }, "response": [] } ] } ] } ] }