{ "info": { "name": "cStar API", "description": "Complete cStar REST API collection. Auto-generated from https://cstar.help/developers", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://www.cstar.help/api/v1", "type": "string" }, { "key": "teamId", "value": "your-team-uuid", "type": "string" }, { "key": "apiKey", "value": "sk_test_your_key_here", "type": "string" } ], "item": [ { "name": "Tickets", "item": [ { "name": "List Tickets", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets" ], "query": [ { "key": "status", "value": "", "description": "Filter by status", "disabled": true }, { "key": "priority", "value": "", "description": "Filter by priority", "disabled": true }, { "key": "search", "value": "", "description": "Full-text search in title and content", "disabled": true }, { "key": "customerId", "value": "", "description": "Filter tickets by customer", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "Retrieve a paginated list of tickets with optional filtering by status, priority, customer, or search term." } }, { "name": "Get Ticket", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets/{ticketId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets", "{ticketId}" ] }, "description": "Retrieve a single ticket by ID. Includes the full message thread." } }, { "name": "Create Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets" ] }, "description": "Create a new support ticket. Optionally attach it to an existing customer or provide customer details inline.", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"priority\": \"normal\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"tags\": \"\",\n \"notes\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Ticket", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets/{ticketId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets", "{ticketId}" ] }, "description": "Update one or more fields on an existing ticket. Only include the fields you want to change.", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"tags\": \"\",\n \"notes\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Ticket", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets/{ticketId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets", "{ticketId}" ] }, "description": "Permanently delete a ticket and all its messages. This action cannot be undone." } } ] }, { "name": "Customers", "item": [ { "name": "List Customers", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customers", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customers" ], "query": [ { "key": "status", "value": "", "description": "Filter by status", "disabled": true }, { "key": "sentiment", "value": "", "description": "Filter by sentiment", "disabled": true }, { "key": "search", "value": "", "description": "Search by name or email", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "Retrieve a paginated list of customers with optional filtering." } }, { "name": "Get Customer", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customers/{customerId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customers", "{customerId}" ] }, "description": "Retrieve a single customer by ID with their full profile and ticket history summary." } }, { "name": "Create Customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customers", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customers" ] }, "description": "Create a new customer record. Email must be unique within your team.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"tags\": \"\",\n \"notes\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Customer", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customers/{customerId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customers", "{customerId}" ] }, "description": "Update one or more fields on an existing customer.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"sentiment\": \"\",\n \"tags\": \"\",\n \"notes\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Customer", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customers/{customerId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customers", "{customerId}" ] }, "description": "Permanently delete a customer. Associated tickets are preserved but unlinked." } } ] }, { "name": "Customer Groups", "item": [ { "name": "List Customer Groups", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups" ], "query": [ { "key": "search", "value": "", "description": "Search groups by name", "disabled": true }, { "key": "page", "value": "", "description": "Page number (default: 1)", "disabled": true }, { "key": "pageSize", "value": "", "description": "Results per page (default: 25, max: 100)", "disabled": true } ] }, "description": "Retrieve a paginated list of customer groups." } }, { "name": "Create Customer Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups" ] }, "description": "Create a new customer group.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"externalId\": \"\",\n \"customFields\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Customer Group", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups/{groupId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups", "{groupId}" ] }, "description": "Retrieve a single customer group by ID." } }, { "name": "Update Customer Group", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups/{groupId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups", "{groupId}" ] }, "description": "Update a customer group. Only provided fields are changed.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"customFields\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Customer Group", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups/{groupId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups", "{groupId}" ] }, "description": "Delete a customer group. Members are removed from the group but not deleted." } }, { "name": "List Group Members", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups/{groupId}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups", "{groupId}", "members" ], "query": [ { "key": "page", "value": "", "description": "Page number (default: 1)", "disabled": true }, { "key": "pageSize", "value": "", "description": "Results per page (default: 25)", "disabled": true } ] }, "description": "List customers that belong to a group." } }, { "name": "Add Members to Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups/{groupId}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups", "{groupId}", "members" ] }, "description": "Add one or more customers to a group. Duplicates are silently skipped.", "body": { "mode": "raw", "raw": "{\n \"customerId\": \"\",\n \"customerIds\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Member from Group", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/customer-groups/{groupId}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "customer-groups", "{groupId}", "members" ], "query": [ { "key": "customerId", "value": "", "description": "Customer ID to remove", "disabled": false } ] }, "description": "Remove a customer from a group." } } ] }, { "name": "Articles", "item": [ { "name": "List Articles", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/articles", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "articles" ], "query": [ { "key": "category", "value": "", "description": "Filter by category name", "disabled": true }, { "key": "status", "value": "", "description": "Filter by publication status", "disabled": true }, { "key": "isPublic", "value": "", "description": "Filter by public visibility", "disabled": true }, { "key": "search", "value": "", "description": "Full-text search in title and content", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "Retrieve a paginated list of knowledge base articles with optional filtering." } }, { "name": "Get Article", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/articles/{articleId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "articles", "{articleId}" ] }, "description": "Retrieve a single article by ID with full content." } }, { "name": "Create Article", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/articles", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "articles" ] }, "description": "Create a new knowledge base article. Articles start as drafts by default.", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"content\": \"\",\n \"category\": \"\",\n \"status\": \"draft\",\n \"isPublic\": \"false\",\n \"tags\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Article", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/articles/{articleId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "articles", "{articleId}" ] }, "description": "Update one or more fields on an existing article.", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"content\": \"\",\n \"category\": \"\",\n \"status\": \"\",\n \"isPublic\": \"\",\n \"tags\": \"\",\n \"metadata\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Article", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/articles/{articleId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "articles", "{articleId}" ] }, "description": "Permanently delete an article from the knowledge base." } } ] }, { "name": "Messages", "item": [ { "name": "List Messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets/{ticketId}/messages", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets", "{ticketId}", "messages" ] }, "description": "Get all messages for a ticket, ordered chronologically." } }, { "name": "Add Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tickets/{ticketId}/messages", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tickets", "{ticketId}", "messages" ] }, "description": "Add a new message to a ticket thread. Fires the `ticket.message_added` webhook event.", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"sender\": \"agent\",\n \"senderName\": \"\",\n \"isInternal\": \"false\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Webhooks", "item": [ { "name": "List Webhooks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "webhooks" ] }, "description": "Retrieve all configured webhooks for your team." } }, { "name": "Get Webhook", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/webhooks/{webhookId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "webhooks", "{webhookId}" ] }, "description": "Retrieve a single webhook by ID." } }, { "name": "Create Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "webhooks" ] }, "description": "Create a new webhook subscription. The signing secret is returned once — save it immediately.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Webhook", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/webhooks/{webhookId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "webhooks", "{webhookId}" ] }, "description": "Update an existing webhook. Use this to change the URL, events, or toggle active status.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Webhook", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/webhooks/{webhookId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "webhooks", "{webhookId}" ] }, "description": "Permanently delete a webhook subscription." } }, { "name": "Trigger Test Event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/webhooks/trigger-test", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "webhooks", "trigger-test" ] }, "description": "Fire a test webhook event to all active webhooks and CLI listeners. Useful for testing your integration.", "body": { "mode": "raw", "raw": "{\n \"event\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Categories", "item": [ { "name": "List Categories", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/categories", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "categories" ], "query": [ { "key": "isPublic", "value": "", "description": "Filter to public categories only", "disabled": true } ] }, "description": "Retrieve all categories for a team, ordered by sort order then name." } }, { "name": "Create Category", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/categories", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "categories" ] }, "description": "Create a new article category. Slug is auto-generated from the name.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"color\": \"\",\n \"sortOrder\": \"0\",\n \"isPublic\": \"false\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Category", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "categories", "{categoryId}" ] }, "description": "Update one or more fields on an existing category. Only include the fields you want to change.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"color\": \"\",\n \"sortOrder\": \"\",\n \"isPublic\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Category", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "categories", "{categoryId}" ] }, "description": "Permanently delete a category. Articles in this category will become uncategorized." } } ] }, { "name": "Community", "item": [ { "name": "List posts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/community/posts", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "community", "posts" ], "query": [ { "key": "topic", "value": "", "description": "Filter by topic slug", "disabled": true }, { "key": "status", "value": "", "description": "Filter by status", "disabled": true }, { "key": "sort", "value": "recent", "description": "Sort order: recent, votes, comments", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "Get all community posts for the team with optional filters." } }, { "name": "Create post", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/community/posts", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "community", "posts" ] }, "description": "Create a new community post.", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"body\": \"\",\n \"topicId\": \"\",\n \"visibility\": \"public\",\n \"customFields\": \"\",\n \"attachments\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update post status", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/community/posts/{postId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "community", "posts", "{postId}" ] }, "description": "Update a community post status or properties.", "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"is_pinned\": \"\",\n \"is_locked\": \"\",\n \"customFields\": \"\",\n \"attachments\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List topics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/community/topics", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "community", "topics" ] }, "description": "Get all community topics for the team. Each topic includes a customFieldConfig array specifying which custom fields appear on posts in that topic." } } ] }, { "name": "Members", "item": [ { "name": "List Members", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/members", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "members" ], "query": [ { "key": "role", "value": "", "description": "Filter by role", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "List all team members with their roles, levels, and permissions." } }, { "name": "Get Member", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/members/{memberId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "members", "{memberId}" ] }, "description": "Get a single team member by membership ID." } }, { "name": "Update Member Role", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/members/{memberId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "members", "{memberId}" ] }, "description": "Update a member's role. Cannot change the owner role.", "body": { "mode": "raw", "raw": "{\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Member", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/members/{memberId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "members", "{memberId}" ] }, "description": "Remove a member from the team. Cannot remove the team owner." } }, { "name": "List Invites", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/members/../invites", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "members", "..", "invites" ] }, "description": "List pending team invites." } }, { "name": "Send Invite", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/members/../invites", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "members", "..", "invites" ] }, "description": "Send a team invitation email.", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"role\": \"agent\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Settings", "item": [ { "name": "Get Settings", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/settings", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "settings" ] }, "description": "Get all team settings." } }, { "name": "Update Settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/settings", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "settings" ] }, "description": "Update team settings. Only provided fields are changed." } }, { "name": "List Statuses", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/settings/statuses", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "settings", "statuses" ] }, "description": "List all ticket status configurations." } }, { "name": "Get Business Hours", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/settings/business-hours", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "settings", "business-hours" ] }, "description": "Get business hours configuration including timezone and weekly schedule." } }, { "name": "Get Widget Settings", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/settings/widget", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "settings", "widget" ] }, "description": "Get widget appearance and behavior settings." } } ] }, { "name": "Notifications", "item": [ { "name": "List Notifications", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "notifications" ], "query": [ { "key": "unreadOnly", "value": "", "description": "Only return unread notifications", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "List notifications for the authenticated user." } }, { "name": "Get Unread Count", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/notifications/unread-count", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "notifications", "unread-count" ] }, "description": "Get the number of unread notifications." } }, { "name": "Mark All Read", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/notifications/mark-all-read", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "notifications", "mark-all-read" ] }, "description": "Mark all notifications as read." } } ] }, { "name": "Custom Fields", "item": [ { "name": "List Custom Fields", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "custom-fields" ], "query": [ { "key": "entityType", "value": "", "description": "Filter by entity type", "disabled": true } ] }, "description": "List all custom field definitions." } }, { "name": "Create Custom Field", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "custom-fields" ] }, "description": "Create a new custom field definition.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"key\": \"\",\n \"type\": \"\",\n \"entityType\": \"\",\n \"options\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "SLA Rules", "item": [ { "name": "List SLA Rules", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/sla/rules", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "sla", "rules" ] }, "description": "List all SLA rules." } }, { "name": "Create SLA Rule", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/sla/rules", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "sla", "rules" ] }, "description": "Create a new SLA rule.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"priority\": \"\",\n \"responseTarget\": \"\",\n \"resolutionTarget\": \"\",\n \"businessHoursOnly\": \"false\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Analytics", "item": [ { "name": "Get Overview", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/analytics/overview", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "analytics", "overview" ], "query": [ { "key": "period", "value": "week", "description": "Time period", "disabled": true } ] }, "description": "Get a summary of ticket, customer, and CSAT metrics for a time period." } }, { "name": "Get Agent Stats", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/analytics/agents", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "analytics", "agents" ] }, "description": "Get per-agent performance metrics." } } ] }, { "name": "Bulk Operations", "item": [ { "name": "Bulk Operation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/bulk", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "bulk" ] }, "description": "Perform a bulk update or delete on up to 100 resources at once.", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"resource\": \"\",\n \"ids\": \"\",\n \"data\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Export", "item": [ { "name": "Create Export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/export", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "export" ] }, "description": "Export data synchronously. Supports multi-resource JSON or single-resource CSV.", "body": { "mode": "raw", "raw": "{\n \"resources\": \"\",\n \"format\": \"json\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Import", "item": [ { "name": "Run Import", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/import", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "import" ] }, "description": "Import records synchronously. Max 500 per request.", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"records\": \"\",\n \"mergeStrategy\": \"skip\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Import Logs", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/import", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "import" ] }, "description": "List import history logs." } } ] }, { "name": "Audit Log", "item": [ { "name": "List Audit Log", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/audit-log", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "audit-log" ], "query": [ { "key": "action", "value": "", "description": "Filter by action type", "disabled": true }, { "key": "resourceType", "value": "", "description": "Filter by resource type", "disabled": true }, { "key": "actorId", "value": "", "description": "Filter by actor", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (ISO 8601)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (ISO 8601)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "List audit log entries with optional filtering." } } ] }, { "name": "Search", "item": [ { "name": "Search", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/search", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "search" ], "query": [ { "key": "q", "value": "", "description": "Search query", "disabled": false }, { "key": "types", "value": "", "description": "Comma-separated types to search (tickets,customers,articles)", "disabled": true }, { "key": "limit", "value": "10", "description": "Max results", "disabled": true } ] }, "description": "Perform a cross-resource search." } } ] }, { "name": "Tags", "item": [ { "name": "List Tags", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tags", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tags" ] }, "description": "List all tags with usage counts." } }, { "name": "Create Tag", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/tags", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "tags" ] }, "description": "Create a new tag.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Game", "item": [ { "name": "Get Player Stats", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/player", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "player" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get a player's game stats including level, XP, gold, skills, streaks, and season info." } }, { "name": "Get Player by Member ID", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/player/{memberId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "player", "{memberId}" ] }, "description": "Get game stats for a specific team member by their membership ID." } }, { "name": "Get Boss State", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/boss", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "boss" ] }, "description": "Get the current boss battle state including health, phase, abilities, participants, and battle duration." } }, { "name": "Is Boss Active", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/boss/active", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "boss", "active" ] }, "description": "Lightweight check if a boss battle is currently active." } }, { "name": "Deal Boss Damage", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/boss/damage", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "boss", "damage" ] }, "description": "Deal damage to the current boss. Damage is calculated server-side based on ticket priority, skills, and combo state. Clients cannot specify damage values.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"userName\": \"\",\n \"priority\": \"normal\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Spawn Boss", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/boss/spawn", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "boss", "spawn" ] }, "description": "Spawn a new boss battle. Fails if a boss is already active.", "body": { "mode": "raw", "raw": "{\n \"difficulty\": \"medium\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Boss Defeat History", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/boss/defeats", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "boss", "defeats" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "Get the history of defeated bosses with participants and rewards." } }, { "name": "Get Single Defeat", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/boss/defeats/{defeatId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "boss", "defeats", "{defeatId}" ] }, "description": "Get full details for a specific boss defeat." } }, { "name": "Get Leaderboard", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/leaderboard", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "leaderboard" ], "query": [ { "key": "period", "value": "weekly", "description": "Leaderboard period", "disabled": true }, { "key": "limit", "value": "20", "description": "Max results (max 50)", "disabled": true } ] }, "description": "Get team leaderboard rankings for a given period." } }, { "name": "Get My Rank", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/leaderboard/me", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "leaderboard", "me" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false }, { "key": "period", "value": "weekly", "description": "Period", "disabled": true } ] }, "description": "Get the current user's rank on the leaderboard." } }, { "name": "List Achievements", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/achievements", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "achievements" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false }, { "key": "category", "value": "", "description": "Filter by category (volume, boss, streak, etc.)", "disabled": true }, { "key": "unlockedOnly", "value": "", "description": "Only show unlocked achievements", "disabled": true } ] }, "description": "List all achievements with rarity, progress, and summary stats." } }, { "name": "Get Single Achievement", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/achievements/{achievementId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "achievements", "{achievementId}" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get details and progress for a specific achievement." } }, { "name": "Recent Achievements", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/achievements/recent", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "achievements", "recent" ], "query": [ { "key": "limit", "value": "10", "description": "Max results (max 50)", "disabled": true } ] }, "description": "Get recently unlocked achievements across the team." } }, { "name": "Today's Quests", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/quests/today", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "quests", "today" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get today's daily quests with progress. Quests reset at midnight UTC." } }, { "name": "Quest History", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/quests/history", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "quests", "history" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false }, { "key": "limit", "value": "30", "description": "Max days (max 90)", "disabled": true } ] }, "description": "Get past quest completions grouped by date." } }, { "name": "Get Skill Tree", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/skills", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "skills" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get the skill tree with current allocations and available points. 4 skills: Quick Learner (+XP), Treasure Hunter (+Gold), Boss Slayer (+Damage), Social Butterfly (+1-Ups)." } }, { "name": "Allocate Skill Point", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/skills/allocate", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "skills", "allocate" ] }, "description": "Spend an available skill point. Earn 1 point every 5 levels.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"skillId\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Skills", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/skills/reset", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "skills", "reset" ] }, "description": "Reset all skill allocations, returning points to the available pool.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get Current Season", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/seasons/current", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "seasons", "current" ] }, "description": "Get the current active season with badge thresholds and days remaining." } }, { "name": "List Seasons", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/seasons", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "seasons" ], "query": [ { "key": "limit", "value": "10", "description": "Max results (max 20)", "disabled": true } ] }, "description": "Get all seasons (current and past)." } }, { "name": "Season Stats", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/seasons/{seasonId}/stats", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "seasons", "{seasonId}", "stats" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get a user's stats for a specific season (current or past)." } }, { "name": "List One-Ups", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/one-ups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "one-ups" ], "query": [ { "key": "limit", "value": "20", "description": "Max results (max 50)", "disabled": true }, { "key": "userId", "value": "", "description": "Filter by sender or recipient", "disabled": true } ] }, "description": "Get recent one-ups on the team." } }, { "name": "Send One-Up", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/one-ups", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "one-ups" ] }, "description": "Send a one-up to a teammate. 3 free per day (+ social_butterfly skill bonus). Gold one-ups deduct from sender balance. Max 140 char message, max 100 gold.", "body": { "mode": "raw", "raw": "{\n \"senderId\": \"\",\n \"senderName\": \"\",\n \"recipientId\": \"\",\n \"recipientName\": \"\",\n \"message\": \"\",\n \"goldAmount\": \"0\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "One-Ups Remaining", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/one-ups/remaining", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "one-ups", "remaining" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Check how many free one-ups remain today." } }, { "name": "List High Fives", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/high-fives", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "high-fives" ], "query": [ { "key": "limit", "value": "20", "description": "Max results (max 50)", "disabled": true } ] }, "description": "Get recent high fives sent to or from this team." } }, { "name": "Send High Five", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/high-fives", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "high-fives" ] }, "description": "Send a high five to another team. Limited to 1 per team per day. Max 80 char message.", "body": { "mode": "raw", "raw": "{\n \"recipientTeamId\": \"\",\n \"recipientTeamName\": \"\",\n \"senderUserId\": \"\",\n \"senderUserName\": \"\",\n \"senderTeamName\": \"\",\n \"message\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Can Send High Five", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/high-fives/can-send/{recipientTeamId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "high-fives", "can-send", "{recipientTeamId}" ] }, "description": "Check if you can send a high five to a specific team today." } }, { "name": "List Cosmetics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/cosmetics", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "cosmetics" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false }, { "key": "type", "value": "", "description": "Filter by type", "disabled": true } ] }, "description": "Get all cosmetic items with unlock status." } }, { "name": "Get Cosmetic Preferences", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/cosmetics/preferences", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "cosmetics", "preferences" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get the user's currently equipped cosmetics." } }, { "name": "Update Cosmetic Preferences", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/cosmetics/preferences", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "cosmetics", "preferences" ] }, "description": "Equip a cosmetic. Can only equip unlocked items. Victory message max 200 chars.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"avatarFrame\": \"\",\n \"victoryMessage\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Today's Puzzle", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/puzzles/today", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "puzzles", "today" ], "query": [ { "key": "userId", "value": "", "description": "Include completion status if provided", "disabled": true } ] }, "description": "Get today's daily warm-up puzzle." } }, { "name": "Complete Puzzle", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/puzzles/complete", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "puzzles", "complete" ] }, "description": "Record a puzzle completion. Awards XP based on time and mistakes.", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"puzzleId\": \"\",\n \"timeSeconds\": \"\",\n \"mistakes\": \"\",\n \"isWon\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Puzzle Leaderboard", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/puzzles/leaderboard", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "puzzles", "leaderboard" ], "query": [ { "key": "type", "value": "streaks", "description": "Leaderboard type", "disabled": true }, { "key": "puzzleId", "value": "", "description": "Required when type=scores", "disabled": true }, { "key": "limit", "value": "10", "description": "Max results (max 50)", "disabled": true } ] }, "description": "Get puzzle leaderboard — by scores (for a specific puzzle) or by streaks." } }, { "name": "Puzzle Streak", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/puzzles/streak", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "puzzles", "streak" ], "query": [ { "key": "userId", "value": "", "description": "User ID", "disabled": false } ] }, "description": "Get a user's puzzle streak stats." } }, { "name": "Team Activity Feed", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/activity", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "activity" ], "query": [ { "key": "limit", "value": "50", "description": "Max results (max 100)", "disabled": true }, { "key": "before", "value": "", "description": "Cursor — activity ID to paginate from", "disabled": true } ] }, "description": "Get the team-wide game activity feed. Supports cursor-based pagination." } }, { "name": "Member Activity", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/activity/member/{memberId}", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "activity", "member", "{memberId}" ], "query": [ { "key": "limit", "value": "20", "description": "Max results (max 100)", "disabled": true } ] }, "description": "Get activity feed for a specific team member." } }, { "name": "Game Config", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/game/config", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "game", "config" ] }, "description": "Get game balance constants (XP per level, boss difficulties, reward tables, etc). Read-only, no database calls. Any API key can access." } } ] }, { "name": "AI Actions", "item": [ { "name": "Run AI Action", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/ai", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "ai" ] }, "description": "Run an AI action. Available actions: auto-tag (tag a ticket), suggest-reply (generate a response), summarize (summarize a conversation), improve (refine draft text).", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"ticketId\": \"\",\n \"text\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Automations", "item": [ { "name": "List Automations", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/automations", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "automations" ] }, "description": "List all automation rules." } }, { "name": "Create Automation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/automations", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "automations" ] }, "description": "Create a new automation rule.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"triggerEvent\": \"\",\n \"conditions\": \"\",\n \"actions\": \"\",\n \"enabled\": \"true\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Test Automation (Dry Run)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/automations/{ruleId}/test", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "automations", "{ruleId}", "test" ] }, "description": "Dry-run a rule against a specific resource. No actions are executed — just shows what would happen.", "body": { "mode": "raw", "raw": "{\n \"resourceType\": \"\",\n \"resourceId\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Saved Views", "item": [ { "name": "List Views", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/views", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "views" ], "query": [ { "key": "entityType", "value": "", "description": "Filter by entity type", "disabled": true } ] }, "description": "List saved views, optionally filtered by entity type." } }, { "name": "Create View", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/views", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "views" ] }, "description": "Create a saved view.", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entityType\": \"\",\n \"filters\": \"\",\n \"sortField\": \"created_at\",\n \"sortDirection\": \"desc\",\n \"visibility\": \"team\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Execute View", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/views/{viewId}/tickets", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "views", "{viewId}", "tickets" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-indexed)", "disabled": true }, { "key": "pageSize", "value": "20", "description": "Results per page (max 100)", "disabled": true } ] }, "description": "Execute a saved view — returns the filtered and sorted results." } } ] }, { "name": "Billing", "item": [ { "name": "Get Subscription", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/billing/subscription", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "billing", "subscription" ] }, "description": "Get the current subscription status and plan details." } }, { "name": "Create Billing Portal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/teams/{teamId}/billing/portal", "host": [ "{{baseUrl}}" ], "path": [ "teams", "{teamId}", "billing", "portal" ] }, "description": "Create a Stripe billing portal session. Returns a URL where the team admin can manage their subscription.", "body": { "mode": "raw", "raw": "{\n \"returnUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }