{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/ticketeer.bot" } ], "info": { "name": "Ticketeer API Documentation", "_postman_id": "72c72e03-b402-4105-8515-c0736113bdf2", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Channel", "description": "\nEndpoints for interacting with guild channels.", "item": [ { "name": "Send a message to a channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"Foo\",\"avatar_url\":\"https:\\\/\\\/example.com\\\/avatar.png\",\"thread_name\":\"Support Request\",\"content\":\"Hello, world!\",\"flags\":0}" }, "description": "Sends a message to a specific channel in the guild. Supports text channels, forum channels (creates a thread), and thread channels (via webhook).\nWhen a message_id is provided, the existing message is edited instead of sending a new one." }, "response": [] }, { "name": "Update a message in a channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/:message_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/:message_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." }, { "id": "message_id", "key": "message_id", "value": "architecto", "description": "The ID of the message." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"Foo\",\"avatar_url\":\"https:\\\/\\\/example.com\\\/avatar.png\",\"thread_name\":\"Support Request\",\"content\":\"Hello, world!\",\"flags\":0}" }, "description": "Updates a message in a specific channel in the guild." }, "response": [] }, { "name": "Send a custom message to a channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/message\/:custom_message_id\/:channel_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/message\/:custom_message_id\/:channel_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "custom_message_id", "key": "custom_message_id", "value": "architecto", "description": "The ID of the custom message." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"Foo\",\"avatar_url\":\"https:\\\/\\\/example.com\\\/avatar.png\",\"thread_name\":\"Hello World\"}" }, "description": "Sends a custom message to a specific channel in the guild. When a message_id is provided, the existing message is edited instead." }, "response": [] }, { "name": "Update a custom message in a channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/message\/:custom_message_id\/:channel_id\/:message_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/message\/:custom_message_id\/:channel_id\/:message_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "custom_message_id", "key": "custom_message_id", "value": "architecto", "description": "The ID of the custom message." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." }, { "id": "message_id", "key": "message_id", "value": "architecto", "description": "The ID of the message." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"username\":\"Foo\",\"avatar_url\":\"https:\\\/\\\/example.com\\\/avatar.png\",\"thread_name\":\"Hello World\"}" }, "description": "Updates a custom message in a specific channel in the guild." }, "response": [] } ] }, { "name": "Guild", "description": "\nEndpoints for managing guilds.", "item": [ { "name": "Get guild.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details for a specific guild." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"571707999220136938\",\n \"name\": \"My Server\",\n \"premium\": \"672951452783139208\",\n \"premium_ends_at\": \"2024-01-01T00:00:00.000000Z\",\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\"\n}", "name": "The guild" } ] }, { "name": "Sync guild channels, roles, emotes and permissions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/sync", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/sync", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Triggers a sync for the specified guild, including channels, roles, permissions, and tickets." }, "response": [] }, { "name": "List ticket groups.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/groups", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all ticket groups for the specified guild." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"120128186398635144\",\n \"name\": \"Support\",\n \"count\": 5\n }\n ],\n \"current_page\": 1,\n \"first_page_url\": \"\/?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"\/?page=1\",\n \"next_page_url\": null,\n \"path\": \"\/\",\n \"per_page\": 30,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}", "name": "List of ticket groups" } ] }, { "name": "List ticket panels.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/panels", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/panels", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all ticket panels for the specified guild." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"151295371372419517\",\n \"name\": \"Hello, world!\"\n }\n ],\n \"current_page\": 1,\n \"first_page_url\": \"\/?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"\/?page=1\",\n \"next_page_url\": null,\n \"path\": \"\/\",\n \"per_page\": 30,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}", "name": "List of panels" } ] }, { "name": "Get guild ticket stats.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/stats", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/stats", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the ticket statistics for the specified guild." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" } ], "code": 503, "body": "{\"success\":false,\"status\":503,\"message\":\"Service Unavailable\"}", "name": "" } ] }, { "name": "List custom messages.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/messages", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all custom messages for the specified guild." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"338909650515657603\",\n \"name\": \"Hello, world!\"\n }\n ],\n \"current_page\": 1,\n \"first_page_url\": \"\/?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"\/?page=1\",\n \"next_page_url\": null,\n \"path\": \"\/\",\n \"per_page\": 30,\n \"prev_page_url\": null,\n \"to\": 1,\n \"total\": 1\n}", "name": "List of custom messages" } ] }, { "name": "Create ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"529288558333275270\",\"message\":\"Hello, world!\",\"ticket_group_id\":\"465448238625702123\",\"anonymous\":false,\"form\":[{\"type\":\"type\",\"title\":\"Hello, world?\",\"value\":\"Hello, world!\"}]}" }, "description": "Creates a new ticket in the specified guild. Uses the provided ticket group or falls back to the guild's default." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"991009560223081930\",\n \"uuid\": \"value\",\n \"group_id\": \"375163139685838977\",\n \"guild_id\": \"720658030022783112\",\n \"channel_id\": \"923713927840348980\",\n \"owner_id\": \"261106055648330815\",\n \"assigned_id\": \"596762699057745444\",\n \"number\": 1,\n \"status\": \"open\",\n \"rating\": 1,\n \"priority\": 1,\n \"form\": [\n {\n \"type\": \"type\",\n \"title\": \"Hello, world?\",\n \"value\": \"Hello, world!\"\n }\n ],\n \"closed_reason\": \"value\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"opened_at\": \"2024-01-01T00:00:00.000000Z\",\n \"closed_at\": \"2024-01-01T00:00:00.000000Z\",\n \"deleted_at\": \"2024-01-01T00:00:00.000000Z\",\n \"last_activity\": \"value\"\n}", "name": "The ticket created" } ] } ] }, { "name": "Ticket", "description": "", "item": [ { "name": "Get ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details for a specific ticket." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"991009560223081930\",\n \"uuid\": \"value\",\n \"group_id\": \"375163139685838977\",\n \"guild_id\": \"720658030022783112\",\n \"channel_id\": \"923713927840348980\",\n \"owner_id\": \"261106055648330815\",\n \"assigned_id\": \"596762699057745444\",\n \"number\": 1,\n \"status\": \"open\",\n \"rating\": 1,\n \"priority\": 1,\n \"form\": [\n {\n \"type\": \"type\",\n \"title\": \"Hello, world?\",\n \"value\": \"Hello, world!\"\n }\n ],\n \"closed_reason\": \"value\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"opened_at\": \"2024-01-01T00:00:00.000000Z\",\n \"closed_at\": \"2024-01-01T00:00:00.000000Z\",\n \"deleted_at\": \"2024-01-01T00:00:00.000000Z\",\n \"last_activity\": \"value\"\n}", "name": "The ticket" } ] }, { "name": "Delete ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Closes the ticket and deletes the associated channel." }, "response": [] }, { "name": "Change ticket group.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/move", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/move", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ticket_group_id\":\"165411793664369316\",\"reason\":\"Hello, world!\"}" }, "description": "Moves a ticket to a different ticket group. The target group must use the same mode (thread or channel) as the current group." }, "response": [] }, { "name": "Open ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/open", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/open", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Reopens a closed ticket." }, "response": [] }, { "name": "Close ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/close", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/close", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Closes an open ticket." }, "response": [] }, { "name": "Assign ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/assign", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Assigns a user to the ticket." }, "response": [] }, { "name": "Unassign ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/unassign", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Removes the assigned user from the ticket." }, "response": [] }, { "name": "Set ticket expiry.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/expire", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/expire", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"expire_at\":\"2026-03-01T00:00:00Z\",\"reason\":\"Hello, world!\"}" }, "description": "Sets or updates the expiry time for a ticket." }, "response": [] }, { "name": "Set ticket eternal.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/eternal", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/eternal", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Sets or updates the eternal status for a ticket, preventing automatic expiry." }, "response": [] }, { "name": "Lock ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/lock", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/lock", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Locks a ticket to prevent further messages." }, "response": [] }, { "name": "Unlock ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/unlock", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/unlock", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Unlocks a previously locked ticket." }, "response": [] }, { "name": "Rename ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/name", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/name", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"hello-world\",\"reason\":\"Hello, world!\"}" }, "description": "Updates the name of a ticket. If the name is empty, the current name is cleared." }, "response": [] }, { "name": "Create ticket notes thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/notes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/notes", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"hello-world\",\"reason\":\"Hello, world!\"}" }, "description": "Creates a private notes thread attached to the ticket." }, "response": [] }, { "name": "Add user to ticket notes thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/notes\/add", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/notes\/add", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Adds a guild member to the ticket's private notes thread." }, "response": [] }, { "name": "Remove user from ticket notes thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/notes\/remove", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/notes\/remove", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Removes a guild member from the ticket's private notes thread." }, "response": [] }, { "name": "Set ticket priority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/priority", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/priority", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"priority\":1,\"reason\":\"Hello, world!\"}" }, "description": "Updates the priority level of a ticket." }, "response": [] }, { "name": "Get ticket transcript.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/transcript", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/transcript", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the full transcript for a ticket, including channel and thread messages with attachments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"guild\": {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"premium\": false,\n \"roles\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"color\": \"value\",\n \"position\": 1,\n \"hoist\": false\n }\n ],\n \"channels\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"type\": 0,\n \"parent_id\": \"123456789\",\n \"position\": 1\n }\n ]\n },\n \"group\": {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"form_title\": \"value\",\n \"form_fields\": [\n []\n ],\n \"schedule\": [],\n \"schedule_timezone\": \"value\",\n \"priority_levels\": [\n {\n \"label\": \"value\",\n \"color\": \"value\"\n }\n ],\n \"rating_levels\": [\n {\n \"label\": \"value\",\n \"color\": \"value\"\n }\n ]\n },\n \"ticket\": {\n \"id\": \"123456789\",\n \"uuid\": \"value\",\n \"status\": \"value\",\n \"owner_id\": \"123456789\",\n \"channel_id\": \"123456789\",\n \"thread_id\": \"123456789\",\n \"assigned_id\": \"123456789\",\n \"number\": 1,\n \"priority\": 1,\n \"rating\": 1,\n \"private\": false,\n \"form\": [],\n \"locked_at\": \"2024-01-01T00:00:00.000000Z\",\n \"opened_at\": \"2024-01-01T00:00:00.000000Z\",\n \"closed_reason\": \"value\",\n \"closed_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"deleted_at\": \"2024-01-01T00:00:00.000000Z\",\n \"transcript_saved_at\": \"2024-01-01T00:00:00.000000Z\"\n },\n \"channel_members\": [\n {\n \"id\": \"123456789\",\n \"avatar\": \"https:\/\/example.com\/image.png\",\n \"name\": \"example\",\n \"bot\": false,\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\",\n \"roles\": [],\n \"rating\": 1\n }\n ],\n \"channel_messages\": [],\n \"channel_message_attachments\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"hash\": \"value\",\n \"mime\": \"value\",\n \"size\": 1,\n \"url\": \"https:\/\/example.com\/image.png\",\n \"encrypted\": false\n }\n ],\n \"thread_members\": [\n {\n \"id\": \"123456789\",\n \"avatar\": \"https:\/\/example.com\/image.png\",\n \"name\": \"example\",\n \"bot\": false,\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\",\n \"roles\": [],\n \"rating\": 1\n }\n ],\n \"thread_messages\": [],\n \"thread_message_attachments\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"hash\": \"value\",\n \"mime\": \"value\",\n \"size\": 1,\n \"url\": \"https:\/\/example.com\/image.png\",\n \"encrypted\": false\n }\n ]\n}", "name": "The ticket transcript" } ] }, { "name": "Save ticket transcript.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/save", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/save", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Saves the current state of a ticket's transcript and returns the updated transcript data." }, "response": [] }, { "name": "Send ticket transcript to a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/send\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/send\/:user_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." }, { "id": "user_id", "key": "user_id", "value": "1001168331996409856", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Queues the ticket transcript to be sent to the specified user via DM." }, "response": [] }, { "name": "Change ticket owner.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/owner", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/owner", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Transfers ownership of a ticket to another user." }, "response": [] }, { "name": "Add user to ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/add", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/add", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Adds a guild member to the ticket, granting them access to the ticket channel." }, "response": [] }, { "name": "Remove user from ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/remove", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/ticket\/:ticket_id\/remove", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "ticket_id", "key": "ticket_id", "value": "1419244951635763635", "description": "The ID of the ticket." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Removes a guild member from the ticket, revoking their access to the ticket channel." }, "response": [] }, { "name": "Send ticket transcript to a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel\/ticket\/send\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel\/ticket\/send\/:user_id", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel", "key": "channel", "value": "1430817781229813802", "description": "The channel." }, { "id": "user_id", "key": "user_id", "value": "1001168331996409856", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Queues the ticket transcript to be sent to the specified user via DM." }, "response": [] } ] }, { "name": "Ticket (from channel)", "description": "", "item": [ { "name": "Get ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details for a specific ticket." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"991009560223081930\",\n \"uuid\": \"value\",\n \"group_id\": \"375163139685838977\",\n \"guild_id\": \"720658030022783112\",\n \"channel_id\": \"923713927840348980\",\n \"owner_id\": \"261106055648330815\",\n \"assigned_id\": \"596762699057745444\",\n \"number\": 1,\n \"status\": \"open\",\n \"rating\": 1,\n \"priority\": 1,\n \"form\": [\n {\n \"type\": \"type\",\n \"title\": \"Hello, world?\",\n \"value\": \"Hello, world!\"\n }\n ],\n \"closed_reason\": \"value\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"opened_at\": \"2024-01-01T00:00:00.000000Z\",\n \"closed_at\": \"2024-01-01T00:00:00.000000Z\",\n \"deleted_at\": \"2024-01-01T00:00:00.000000Z\",\n \"last_activity\": \"value\"\n}", "name": "The ticket" } ] }, { "name": "Delete ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Closes the ticket and deletes the associated channel." }, "response": [] }, { "name": "Change ticket group.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/move", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/move", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ticket_group_id\":\"165411793664369316\",\"reason\":\"Hello, world!\"}" }, "description": "Moves a ticket to a different ticket group. The target group must use the same mode (thread or channel) as the current group." }, "response": [] }, { "name": "Open ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/open", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/open", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Reopens a closed ticket." }, "response": [] }, { "name": "Close ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/close", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/close", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Closes an open ticket." }, "response": [] }, { "name": "Assign ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/assign", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Assigns a user to the ticket." }, "response": [] }, { "name": "Unassign ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/unassign", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/unassign", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Removes the assigned user from the ticket." }, "response": [] }, { "name": "Set ticket expiry.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/expire", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/expire", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"expire_at\":\"2026-03-01T00:00:00Z\",\"reason\":\"Hello, world!\"}" }, "description": "Sets or updates the expiry time for a ticket." }, "response": [] }, { "name": "Set ticket eternal.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/eternal", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/eternal", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Sets or updates the eternal status for a ticket, preventing automatic expiry." }, "response": [] }, { "name": "Lock ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/lock", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/lock", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Locks a ticket to prevent further messages." }, "response": [] }, { "name": "Unlock ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/unlock", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/unlock", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Hello, world!\"}" }, "description": "Unlocks a previously locked ticket." }, "response": [] }, { "name": "Rename ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/name", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/name", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"hello-world\",\"reason\":\"Hello, world!\"}" }, "description": "Updates the name of a ticket. If the name is empty, the current name is cleared." }, "response": [] }, { "name": "Create ticket notes thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/notes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/notes", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"hello-world\",\"reason\":\"Hello, world!\"}" }, "description": "Creates a private notes thread attached to the ticket." }, "response": [] }, { "name": "Add user to ticket notes thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/notes\/add", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/notes\/add", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Adds a guild member to the ticket's private notes thread." }, "response": [] }, { "name": "Remove user from ticket notes thread.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/notes\/remove", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/notes\/remove", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Removes a guild member from the ticket's private notes thread." }, "response": [] }, { "name": "Set ticket priority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/priority", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/priority", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"priority\":1,\"reason\":\"Hello, world!\"}" }, "description": "Updates the priority level of a ticket." }, "response": [] }, { "name": "Get ticket transcript.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/transcript", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/transcript", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the full transcript for a ticket, including channel and thread messages with attachments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"guild\": {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"premium\": false,\n \"roles\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"color\": \"value\",\n \"position\": 1,\n \"hoist\": false\n }\n ],\n \"channels\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"type\": 0,\n \"parent_id\": \"123456789\",\n \"position\": 1\n }\n ]\n },\n \"group\": {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"form_title\": \"value\",\n \"form_fields\": [\n []\n ],\n \"schedule\": [],\n \"schedule_timezone\": \"value\",\n \"priority_levels\": [\n {\n \"label\": \"value\",\n \"color\": \"value\"\n }\n ],\n \"rating_levels\": [\n {\n \"label\": \"value\",\n \"color\": \"value\"\n }\n ]\n },\n \"ticket\": {\n \"id\": \"123456789\",\n \"uuid\": \"value\",\n \"status\": \"value\",\n \"owner_id\": \"123456789\",\n \"channel_id\": \"123456789\",\n \"thread_id\": \"123456789\",\n \"assigned_id\": \"123456789\",\n \"number\": 1,\n \"priority\": 1,\n \"rating\": 1,\n \"private\": false,\n \"form\": [],\n \"locked_at\": \"2024-01-01T00:00:00.000000Z\",\n \"opened_at\": \"2024-01-01T00:00:00.000000Z\",\n \"closed_reason\": \"value\",\n \"closed_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"deleted_at\": \"2024-01-01T00:00:00.000000Z\",\n \"transcript_saved_at\": \"2024-01-01T00:00:00.000000Z\"\n },\n \"channel_members\": [\n {\n \"id\": \"123456789\",\n \"avatar\": \"https:\/\/example.com\/image.png\",\n \"name\": \"example\",\n \"bot\": false,\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\",\n \"roles\": [],\n \"rating\": 1\n }\n ],\n \"channel_messages\": [],\n \"channel_message_attachments\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"hash\": \"value\",\n \"mime\": \"value\",\n \"size\": 1,\n \"url\": \"https:\/\/example.com\/image.png\",\n \"encrypted\": false\n }\n ],\n \"thread_members\": [\n {\n \"id\": \"123456789\",\n \"avatar\": \"https:\/\/example.com\/image.png\",\n \"name\": \"example\",\n \"bot\": false,\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\",\n \"roles\": [],\n \"rating\": 1\n }\n ],\n \"thread_messages\": [],\n \"thread_message_attachments\": [\n {\n \"id\": \"123456789\",\n \"name\": \"example\",\n \"hash\": \"value\",\n \"mime\": \"value\",\n \"size\": 1,\n \"url\": \"https:\/\/example.com\/image.png\",\n \"encrypted\": false\n }\n ]\n}", "name": "The ticket transcript" } ] }, { "name": "Save ticket transcript.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/save", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/save", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Saves the current state of a ticket's transcript and returns the updated transcript data." }, "response": [] }, { "name": "Change ticket owner.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/owner", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/owner", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Transfers ownership of a ticket to another user." }, "response": [] }, { "name": "Add user to ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/add", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/add", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Adds a guild member to the ticket, granting them access to the ticket channel." }, "response": [] }, { "name": "Remove user from ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/remove", "query": [], "raw": "{{baseUrl}}\/api\/v1\/guild\/:guild_id\/channel\/:channel_id\/ticket\/remove", "variable": [ { "id": "guild_id", "key": "guild_id", "value": "1241080059528347678", "description": "The ID of the guild." }, { "id": "channel_id", "key": "channel_id", "value": "1430817781229813802", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"897219148574363269\",\"reason\":\"Hello, world!\"}" }, "description": "Removes a guild member from the ticket, revoking their access to the ticket channel." }, "response": [] } ] }, { "name": "User", "description": "\nEndpoints for the authenticated user.", "item": [ { "name": "Get current user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/user\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the currently authenticated user's information." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"337842567937046150\",\n \"name\": \"John\",\n \"username\": \"john\",\n \"discriminator\": \"0001\",\n \"avatar\": \"https:\/\/cdn.discordapp.com\/avatars\/123\/abc.png\",\n \"locale\": \"en\",\n \"bot\": false,\n \"verified\": \"934674431964242580\",\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\"\n}", "name": "The authenticated user" } ] }, { "name": "List guilds.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/me\/guilds", "query": [], "raw": "{{baseUrl}}\/api\/v1\/user\/me\/guilds" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all guilds accessible by the authenticated user. Filters out suspended and deleted guilds." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": \"571707999220136938\",\n \"name\": \"My Server\",\n \"premium\": \"672951452783139208\",\n \"premium_ends_at\": \"2024-01-01T00:00:00.000000Z\",\n \"joined_at\": \"2024-01-01T00:00:00.000000Z\"\n }\n]", "name": "List of guilds" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }