Welcome to the Pureservice API documentation. This guide provides a comprehensive overview of the API's capabilities, including authentication, entity management, filtering, paging, and static values. Use this guide to integrate Pureservice into your applications securely and efficiently.
\nThe Pureservice API offers a robust and flexible interface for integrating with the Pureservice platform. It supports secure operations for reading, creating, updating, and managing entities such as tickets, statuses, users, and more.
\n🔑 API Keys
\n🔑 API Tokens
\n⏱️ Rate Limits
\n📏 Entity Limits
\n🔎 Fetching Entities (GET)
\n🔍 Get a Single Entity by ID
\n📋 Get All Entities by Type
\n📑 Get Multiple Entities by IDs
\n➕ Creating Entities (POST)
\n✏️ Updating Entities (PUT/PATCH)
\n🛠️ Example: Partial Update (PATCH)
\n🛠️ Example: Full Update (PUT)
\n🔎 Filtering, Sorting, and Paging
\n🔍 Filtering
\n↕️ Sorting
\n📄 Paging
\n🔗 Including Related Entities
\nUserRole
\nVisibility
\nPhonenumberType
\n📢 AnnouncementType
\nAll API endpoints are served from the Agent application. You must direct your API calls to the Agent URL, not the Selfservice (end-user) portal.
\nFor SaaS customers, the base URL follows this pattern:
\nhttps://{customer}.pureservice.com/agent/api/\n\nFor example, if your Pureservice instance is acme.pureservice.com, your API base URL is:
https://acme.pureservice.com/agent/api/\n\n\n\n⚠️ Important: Do not send API requests to the Selfservice portal URL (e.g.
\nhttps://{customer}.pureservice.com/api/). API calls must always target the Agent application path (/agent/api/).
All examples in this documentation use the SaaS URL pattern (customer.pureservice.com/agent/api). If you are running an on-premises installation the base URL depends on your deployment configuration. Contact your system administrator for the correct Agent URL. Request examples show SaaS requests.
To ensure JSON:API-compliant communication, set the following headers:
\nAccept:
application/vnd.api+json
Content-Type:
application/vnd.api+json (for requests with a payload)
\n\n⚠️ Important: For
\nPATCHrequests, use content-typeapplication/json, see examples.
Example:
\nAccept: application/vnd.api+json\nContent-Type: application/vnd.api+json\n\nAPI keys allow integration with third-party services and are managed via the Pureservice web interface.
\nAuthenticate by passing your API key in the X-Authorization-Key HTTP header with every request.
Best Practices:
\n🔒 Keep keys confidential and rotate regularly.
\n⏳ Set expiration dates where possible.
\n🗑️ Deactivate or delete unused keys.
\nAdministering API Keys:
Navigate to Pureservice > Administration > Security > API keys to manage your keys.
Usage Example:
\nGET /agent/api/status HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nAPI tokens are used for user-based authentication via the Authorization: Bearer header. This method is scheduled for deprecation.
GET /agent/api/status HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nAuthorization: Bearer YOUR_USER_TOKEN\n\n100 requests per minute per client (SaaS only).
\nExceeding this limit returns 429 Too Many Requests with potentially a Retry-After header if applicable.
Example:
\nHTTP/1.1 429 Too Many Requests\nContent-Type: application/json\nRetry-After: 15\n\nMaximum 500 entities per request.
\nUse paging (start and limit parameters) to retrieve more.
GET /agent/api/status/1 HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nor
\nGET /agent/api/status?id=1 HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nGET /agent/api/status/ HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nGET /agent/api/status/?ids=1,5 HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nPOST /agent/api/ticket HTTP/1.1\nHost: customer.pureservice.com\nContent-Type: application/vnd.api+json\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n{\n \"tickets\": [\n {\n \"subject\": \"Cannot access email\",\n \"description\": \"User reports email access issues since this morning.\",\n \"statusId\": 1,\n \"priorityId\": 2,\n \"requestTypeId\": 1,\n \"userId\": 42\n }\n ]\n}\n\nPUT: Full update (missing properties are reset to default).
\nPATCH: Partial update (only specified properties are updated).
\nRecommended: Use PATCH for updates.
PATCH /agent/api/ticket/10 HTTP/1.1\nHost: customer.pureservice.com\nContent-Type: application/json\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n{ \"subject\": \"...\" }\n\nPUT /agent/api/ticket/10 HTTP/1.1\nHost: customer.pureservice.com\nContent-Type: application/vnd.api+json\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n{\n \"tickets\": [\n {\n \"subject\": \"Updated summary\",\n \"description\": \"Full description here.\"\n ...\n }\n ]\n}\n\nUse the filter query parameter to filter entities. Supports logical operators (AND, OR) and standard operators.
Examples:
\nname == \"Closed\"
default == true AND name == \"Open\"
name == \"Closed\" OR (default == true AND name == \"Open\")
Supported Operators:
\nUse the sort query parameter to sort results.
Single field: ?sort=fieldName asc
Multiple fields: ?sort=field1 asc,field2 desc
Default direction is ascending.
\nUse start and limit query parameters for paging.
Example:
\nGET /agent/api/status/?start=0&limit=10 HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nUse the include parameter to include related entities.
Example:
\nGET /agent/api/status/?include=requesttype,createdBy HTTP/1.1\nHost: customer.pureservice.com\nAccept: application/vnd.api+json\nX-Authorization-Key: YOUR_API_KEY\n\nThe following enumerated constants are used throughout the Pureservice API:
\nIf your Pureservice instance uses zone-security features, note:
\n🏷️ Entities with a department or assignedDepartment property must have a non-null value.
🏷️ Entities restricted by a zone must be explicitly assigned to a zone.
\n🏷️ The property is called department in the API for backward compatibility, but is displayed as zone in the UI.
❗ Missing or invalid zone fields result in a 400 Bad Request.
Validation errors are returned as an array of error objects under the errors property.
Example:
\nHTTP/1.1 400 Bad Request\nContent-Type: application/json\n{\n \"errors\": [{\n \"message\": \"SomeFieldOne : SomeFieldOne is required.\"\n }]\n}\n\nFor further details or assistance, contact our support or send us an email at support@pureservice.com.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📚 Table of Contents","slug":"table-of-contents"},{"content":"✅ Return Codes","slug":"return-codes"},{"content":"🌐 Base URL","slug":"base-url"},{"content":"📝 Content Negotiation","slug":"content-negotiation"},{"content":"🔐 Authentication","slug":"authentication"},{"content":"🚦 Limits and Throttling","slug":"limits-and-throttling"},{"content":"🗂️ Entity Operations","slug":"entity-operations"},{"content":"🔎 Filtering, Sorting, and Paging","slug":"filtering-sorting-and-paging"},{"content":"🔢 Static Values","slug":"static-values"},{"content":"🏷️ Zone Security (If Applicable)","slug":"zone-security-if-applicable"},{"content":"❗ Validation Errors","slug":"validation-errors"}],"owner":"398215","collectionId":"e111b3a3-68a2-aba8-0c4a-f8a0225d7019","publishedId":"2SJVwo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-06T14:12:51.000Z"},"item":[{"name":"Count","item":[{"name":"Tickets - Count resolved/closed","id":"a511b95f-f9e2-4054-b96e-730bc1bd6c4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?filter=status.coreStatus >= CoreStatus.Resolved","urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"a511b95f-f9e2-4054-b96e-730bc1bd6c4a"},{"name":"Users - Count having at least agent role","id":"bceee7b5-3aa6-4100-9ca6-50187ab809c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/user/count/?filter=role == UserRole.Agent || role == UserRole.Administrator","urlObject":{"protocol":"https","path":["agent","api","user","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"role == UserRole.Agent || role == UserRole.Administrator"}],"variable":[]}},"response":[],"_postman_id":"bceee7b5-3aa6-4100-9ca6-50187ab809c9"}],"id":"988886ae-afc3-4e13-a58c-00729340a92b","_postman_id":"988886ae-afc3-4e13-a58c-00729340a92b","description":""},{"name":"Count with grouping (Reporting)","item":[{"name":"Change - Group by Category Level 2, Year","id":"781db6b2-8536-4d74-9214-fb5fcf9abf14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/change/count/?groupBy=category2.name,created.Year&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","change","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"category2.name,created.Year"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"781db6b2-8536-4d74-9214-fb5fcf9abf14"},{"name":"Tickets - Group by Team","id":"dac0b510-449b-4d9d-ac28-9c0d8f826e1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=assignedTeam.name&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"assignedTeam.name"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"dac0b510-449b-4d9d-ac28-9c0d8f826e1a"},{"name":"Tickets - Group by Year, Month, Team","id":"9cef00af-3104-43c7-a0e2-3b92a01a3656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=created.Year,created.Month,assignedTeam.name&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"created.Year,created.Month,assignedTeam.name"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"9cef00af-3104-43c7-a0e2-3b92a01a3656"},{"name":"Tickets - Group by Category Level 1, Year","id":"86ca6bb2-9fb9-408f-a220-aeffe23e701a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=category1.name,created.Year&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"category1.name,created.Year"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"86ca6bb2-9fb9-408f-a220-aeffe23e701a"},{"name":"Tickets - Group by Year, Assigned Agent","id":"58daf68e-baa5-463c-a43a-e79398341f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=created.Year,assignedAgent.fullName&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"created.Year,assignedAgent.fullName"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"58daf68e-baa5-463c-a43a-e79398341f73"},{"name":"Tickets - Group by Enduser Country","id":"965cba24-1698-48e2-a922-e025d0d595db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=user.address.country,created.year,created.month&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"user.address.country,created.year,created.month"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"965cba24-1698-48e2-a922-e025d0d595db"},{"name":"Tickets - Group by Source, Year","id":"f14f39d5-0dde-467c-b88f-035ac5c1d467","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=source.name,created.year&filter=status.coreStatus >= CoreStatus.Resolved","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"source.name,created.year"},{"key":"filter","value":"status.coreStatus >= CoreStatus.Resolved"}],"variable":[]}},"response":[],"_postman_id":"f14f39d5-0dde-467c-b88f-035ac5c1d467"},{"name":"Tickets - Group by Ticket type, Category level 3 - With SLA and RequestNumber","id":"f5c31e2b-83f4-49ea-95b4-e079a1ff20c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=tickettype.name,category3.name&select=requestNumber,serviceTargetRelationships[breached,timeUsed,serviceTarget.name]&filter=serviceTargetRelationships.Any() %26%26 created.Year == 2021","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"tickettype.name,category3.name"},{"key":"select","value":"requestNumber,serviceTargetRelationships[breached,timeUsed,serviceTarget.name]"},{"key":"filter","value":"serviceTargetRelationships.Any() && created.Year == 2021"}],"variable":[]}},"response":[],"_postman_id":"f5c31e2b-83f4-49ea-95b4-e079a1ff20c6"},{"name":"Tickets - Group by Assigned Team - Select Average diff hours","id":"90056394-6d9e-4683-8192-640506f61f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=assignedTeam.name&select=average-diff-hours(created,resolved)&filter=created.Year == 2020","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"assignedTeam.name"},{"key":"select","value":"average-diff-hours(created,resolved)"},{"key":"filter","value":"created.Year == 2020"}],"variable":[]}},"response":[],"_postman_id":"90056394-6d9e-4683-8192-640506f61f14"},{"name":"Tickets - Group by Assigned Agent- Select Average diff days","id":"d02bb654-4d00-42a8-990d-816115292d10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=assignedAgent.fullName&select=average-diff-days(created,resolved)&filter=created.Year == 2020","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"assignedAgent.fullName"},{"key":"select","value":"average-diff-days(created,resolved)"},{"key":"filter","value":"created.Year == 2020"}],"variable":[]}},"response":[],"_postman_id":"d02bb654-4d00-42a8-990d-816115292d10"},{"name":"Tickets - Group by Assigned Agent- Select Average diff minutes","id":"0215d633-fab4-498b-bb75-3448caeeec99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/count/?groupBy=assignedAgent.fullName&select=average-diff-minutes(created,resolved)&filter=created.Year == 2021","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","id":"4aa68e8a-9585-4805-a65d-096f937693b4","name":"Count with grouping (Reporting)","type":"folder"}},"urlObject":{"protocol":"https","path":["agent","api","ticket","count",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"groupBy","value":"assignedAgent.fullName"},{"key":"select","value":"average-diff-minutes(created,resolved)"},{"key":"filter","value":"created.Year == 2021"}],"variable":[]}},"response":[],"_postman_id":"0215d633-fab4-498b-bb75-3448caeeec99"}],"id":"4aa68e8a-9585-4805-a65d-096f937693b4","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ac77f836-585e-41c6-842d-017ceaecd40c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c9900fd5-cdb2-4393-9d56-198a6140ec1f","type":"text/javascript","exec":[""]}}],"_postman_id":"4aa68e8a-9585-4805-a65d-096f937693b4","description":""},{"name":"Patch","item":[{"name":"Ticket - Update subject and description (with return)","event":[{"listen":"prerequest","script":{"id":"c8691667-571f-4bed-abe4-378829c58dcc","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"7c7abe8f-7e12-4622-be1b-ddd6805ef626","exec":[""],"type":"text/javascript"}}],"id":"9ab1442d-6ed4-4077-b4d4-158092aa0321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/json"},{"key":"X-Authorization-Key","value":"{{apikey}}","type":"default"}],"body":{"mode":"raw","raw":"{\r\n \"subject\": \"Updated subject\",\r\n \"description\": \"Updated description\"\r\n}"},"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/{{ticketId}}","urlObject":{"protocol":"https","path":["agent","api","ticket","{{ticketId}}"],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ab1442d-6ed4-4077-b4d4-158092aa0321"},{"name":"Ticket - Update subject and description (without return)","event":[{"listen":"prerequest","script":{"id":"effb745f-dec4-4a5f-a0d2-fea0b548ca79","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"7cb9257e-0f53-416d-b403-9f2df1f6fcbb","exec":[""],"type":"text/javascript"}}],"id":"3be9dc64-cb17-4198-aa44-494d63306eb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Authorization-Key","value":"{{apikey}}","type":"default"}],"body":{"mode":"raw","raw":"{\r\n \"subject\": \"Updated subject\",\r\n \"description\": \"Updated description\"\r\n}"},"url":"https://{{tenant.pureservice.com}}/agent/api/ticket/{{ticketId}}","urlObject":{"protocol":"https","path":["agent","api","ticket","{{ticketId}}"],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3be9dc64-cb17-4198-aa44-494d63306eb1"}],"id":"c7e747a1-8a0a-48c2-973e-8b8b3c8ccca4","_postman_id":"c7e747a1-8a0a-48c2-973e-8b8b3c8ccca4","description":""},{"name":"Announcement","item":[{"name":"Announcement - List all active announcements","id":"30f7b6a1-cf99-47a6-aa46-f8df04f71a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}","type":"text"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"url":"https://{{tenant.pureservice.com}}/agent/api/announcement/?filter=activeFrom == [beforenow] %26%26 activeTo == [afternow]","urlObject":{"protocol":"https","path":["agent","api","announcement",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"activeFrom == [beforenow] %26%26 activeTo == [afternow]"}],"variable":[]}},"response":[],"_postman_id":"30f7b6a1-cf99-47a6-aa46-f8df04f71a81"},{"name":"Announcement - List all active announcements of critical type","id":"5089f331-97be-4523-9155-b0e378299a2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}","type":"text"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"url":"https://{{tenant.pureservice.com}}/agent/api/announcement/?filter=activeFrom == [beforenow] %26%26 activeTo == [afternow] %26%26 announcementType == AnnouncementType.Critical","urlObject":{"protocol":"https","path":["agent","api","announcement",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"activeFrom == [beforenow] %26%26 activeTo == [afternow] %26%26 announcementType == AnnouncementType.Critical"}],"variable":[]}},"response":[],"_postman_id":"5089f331-97be-4523-9155-b0e378299a2b"},{"name":"Announcement - List all active announcements for a specific department/zone","id":"ecbccaa0-804e-4589-a043-edcfb65e3778","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}","type":"text"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"url":"https://{{tenant.pureservice.com}}/agent/api/announcement/?filter=activeFrom == [beforenow] %26%26 activeTo == [afternow] %26%26 departmentId == 1","urlObject":{"protocol":"https","path":["agent","api","announcement",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"activeFrom == [beforenow] %26%26 activeTo == [afternow] %26%26 departmentId == 1"}],"variable":[]}},"response":[],"_postman_id":"ecbccaa0-804e-4589-a043-edcfb65e3778"},{"name":"Announcement - Create new","id":"8316a365-fded-40ee-8d05-a1eb36aa0180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"X-Authorization-Key","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"announcements\": [\r\n {\r\n \"subject\": \"Summary\",\r\n \"description\": \"Description\",\r\n \"announcementType\": 1,\r\n \"activeFrom\": \"2025-01-01T00:00:00.000Z\",\r\n \"activeTo\": \"2025-01-02T12:00:00.000Z\",\r\n \"departmentId\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{tenant.pureservice.com}}/agent/api/announcement/","urlObject":{"protocol":"https","path":["agent","api","announcement",""],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8316a365-fded-40ee-8d05-a1eb36aa0180"},{"name":"Announcement - Update","id":"a4a4dbba-db9d-4bac-850e-374b2af09449","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"X-Authorization-Key","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"announcements\": [\r\n {\r\n \"id\": \"1\",\r\n \"subject\": \"Updated summary\",\r\n \"description\": \"Updated description\",\r\n \"announcementType\": 1,\r\n \"activeFrom\": \"2025-01-01T00:00:00.000Z\",\r\n \"activeTo\": \"2025-01-02T12:00:00.000Z\",\r\n \"departmentId\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{tenant.pureservice.com}}/agent/api/announcement/1","urlObject":{"protocol":"https","path":["agent","api","announcement","1"],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4a4dbba-db9d-4bac-850e-374b2af09449"}],"id":"f4c19043-dd6d-49b6-a69f-f8f846442800","_postman_id":"f4c19043-dd6d-49b6-a69f-f8f846442800","description":""},{"name":"Asset","item":[{"name":"Asset","event":[{"listen":"test","script":{"id":"86825ea2-6831-4dfe-8c70-8f184dfd590d","exec":[""],"type":"text/javascript"}}],"id":"7aa374ad-f21a-4be8-ae44-9ac63eecfdf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/asset/{{assetId}}","urlObject":{"protocol":"https","path":["agent","api","asset","{{assetId}}"],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7aa374ad-f21a-4be8-ae44-9ac63eecfdf7"},{"name":"Assets - Search with query","event":[{"listen":"test","script":{"id":"e6db8f3e-e17c-4f91-8905-42d86311bb63","exec":["if(pm.response.to.have.status(200)) {\r"," //const ticket = pm.response.json().tickets[0];\r"," pm.environment.set(\"assetId\", pm.response.json().assets[0].id);\r","}"],"type":"text/javascript"}}],"id":"6bb430f0-ab6b-487d-bda1-01fc2ae7a8dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/asset/search?query=IT&limit=5","urlObject":{"protocol":"https","path":["agent","api","asset","search"],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"query","value":"IT"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"6bb430f0-ab6b-487d-bda1-01fc2ae7a8dc"},{"name":"Asset types - List asset types detailed information","event":[{"listen":"test","script":{"id":"9384603b-dbfc-4866-b3b4-9904b0db6c81","exec":[""],"type":"text/javascript"}}],"id":"6d8b3f76-aec4-4d3e-a8e7-336c091f9f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/assettype/","urlObject":{"protocol":"https","path":["agent","api","assettype",""],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d8b3f76-aec4-4d3e-a8e7-336c091f9f7d"},{"name":"Asset type - List asset type with fields and statuses","event":[{"listen":"test","script":{"id":"9384603b-dbfc-4866-b3b4-9904b0db6c81","exec":[""],"type":"text/javascript"}}],"id":"a1177794-61f5-4964-ac21-8e478be7890f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/assettype/{{assetTypeId}}?include=fields,statuses","urlObject":{"protocol":"https","path":["agent","api","assettype","{{assetTypeId}}"],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"include","value":"fields,statuses"}],"variable":[]}},"response":[],"_postman_id":"a1177794-61f5-4964-ac21-8e478be7890f"},{"name":"Asset - Create new","event":[{"listen":"test","script":{"id":"952f18ba-5c0d-4b77-992d-776b236b15f8","exec":[""],"type":"text/javascript"}}],"id":"20ceefe7-b155-4663-9719-6ef0d41c5574","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"{{assetType_uniqueClassName}}\": [\r\n {\r\n \"assets_UDF_95_Model\": \"UHD S2722QC\",\r\n \"assets_UDF_95_Serial_32_number\": \"0b9d814f-4f75-4005-b398-f37605e5c5e9\",\r\n \"assets_UDF_95_Purchase_32_date\": \"2021-08-31T22:00:00.000Z\",\r\n \"assets_UDF_95_VendorItemId\": 4,\r\n \"assets_UDF_95_Warranty_32_expiration\": null,\r\n \"assets_UDF_95_Size_32__40_inches_41_\": 27,\r\n \"assets_UDF_95_OwnerUserId\": \"21\",\r\n \"links\": {\r\n \"type\": {\r\n \"id\": {{assetTypeId}}\r\n },\r\n \"status\": {\r\n \"id\": {{assetStatusId}}\r\n }\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{tenant.pureservice.com}}/agent/api/asset/{{assetType_uniqueClassName}}","description":"Replace {{assetType_uniqueClassName}} by selecting the appropriate \"UniqueClassName\" for the desired asset type by querying the asset type endpoint. ({{url}}/assettype/)
\nBuild the JSON body by querying the asset type endpoint for one particular type and include fields and/or statuses. Property names can be extracted from links.assettypefields.propertyName. ({{url}}/assettype/{{assetTypeId}}?include=fields,statuses).
\nReplace {{assetType_uniqueClassName}} by selecting the appropriate \"UniqueClassName\" for the desired asset type by querying the asset type endpoint. ({{url}}/assettype/)
\nBuild the JSON body by querying the asset type endpoint for one particular type and include fields and/or statuses. Property names can be extracted from links.assettypefields.propertyName. ({{url}}/assettype/{{assetTypeId}}?include=fields,statuses).
\n{\n Note = 1,\n Message = 2,\n Sms = 3,\n Solution = 4,\n PreviousSolution = 5,\n History = 6,\n InitialMessage = 7,\n TaskHistory = 8,\n Timeloghistory = 9,\n ServicetargetHistory = 10,\n AttachmentHistory = 11,\n RiskHistory = 12,\n RollbackPlanHistory = 13,\n TransferComment = 14,\n Custom = 90\n}\n\n{\n Inbound = 1,\n Outbound = 2,\n None = 3\n}\n\n{\n NotPublished = 0,\n PublishedToSelfservice = 1,\n PublishedToPureservice = 2,\n PublishedToBoth = 3\n}\n\nStatus with API KEY
\n","urlObject":{"protocol":"https","path":["agent","api","status","{{statusId}}"],"host":["{{tenant.pureservice.com}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad61a6aa-3173-4bb0-95dd-03b3dbe8f3eb"},{"name":"Status - With Include","id":"0d069883-3615-4420-a354-24e97db37122","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status/{{statusId}}/?include=requestType","urlObject":{"protocol":"https","path":["agent","api","status","{{statusId}}",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"include","value":"requestType"}],"variable":[]}},"response":[],"_postman_id":"0d069883-3615-4420-a354-24e97db37122"},{"name":"Statuses","id":"397f866f-cac5-4828-ab7c-47d84a635115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status/?limit=10","urlObject":{"protocol":"https","path":["agent","api","status",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"397f866f-cac5-4828-ab7c-47d84a635115"},{"name":"Statuses - Ids filter","id":"28381c09-7449-4513-9721-54e0691cbb9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status?ids=1,2","urlObject":{"protocol":"https","path":["agent","api","status"],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"ids","value":"1,2"}],"variable":[]}},"response":[],"_postman_id":"28381c09-7449-4513-9721-54e0691cbb9c"},{"name":"Statuses - Filter default statuses","id":"8e5030f3-3874-45e3-b933-70357437a7a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status?filter=default&limit=10","urlObject":{"protocol":"https","path":["agent","api","status"],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"default"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"8e5030f3-3874-45e3-b933-70357437a7a4"},{"name":"Statuses - Filter advanced","id":"50a35b54-b61c-4808-8d99-f88ca58d73d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status?filter=default %26%26 name.contains(\"Clo\")&limit=10","urlObject":{"protocol":"https","path":["agent","api","status"],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"default && name.contains(\"Clo\")"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"50a35b54-b61c-4808-8d99-f88ca58d73d0"},{"name":"Statuses - Filter advanced nested with include","id":"ecd007c8-65c4-478f-8280-0c6c60488d2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status/?filter=default == true %26%26 name == \"Closed\"&include=requestType&limit=10","urlObject":{"protocol":"https","path":["agent","api","status",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"default == true && name == \"Closed\""},{"key":"include","value":"requestType"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"ecd007c8-65c4-478f-8280-0c6c60488d2b"},{"name":"Statuses - Filter advanced nested with includes","id":"bb1ce8c5-5f0e-4947-96c9-820ccf66c74c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status/?filter=default == true %26%26 name == \"Closed\"&include=requestType,createdBy,createdBy.emailAddress&limit=10","urlObject":{"protocol":"https","path":["agent","api","status",""],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"default == true && name == \"Closed\""},{"key":"include","value":"requestType,createdBy,createdBy.emailAddress"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"bb1ce8c5-5f0e-4947-96c9-820ccf66c74c"},{"name":"Statuses - Filter advanced nested","id":"341755bf-0f96-4d55-9b65-e11251946d41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Authorization-Key","value":"{{apikey}}"},{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://{{tenant.pureservice.com}}/agent/api/status?filter=(default == true %26%26 name.contains(\"Clo\")) || name == \"In Progress\" || coreStatus == CoreStatus..New&limit=10","urlObject":{"protocol":"https","path":["agent","api","status"],"host":["{{tenant.pureservice.com}}"],"query":[{"key":"filter","value":"(default == true && name.contains(\"Clo\")) || name == \"In Progress\" || coreStatus == CoreStatus..New"},{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"341755bf-0f96-4d55-9b65-e11251946d41"}],"id":"5889127b-f69b-4426-b9a8-9b2544e2b377","description":"{\n // Ticket\n New = 10,\n Assigned = 20,\n Open = 30,\n Pending = 40,\n PendingCustomer = 42,\n Resolved = 50,\n Closed = 60,\n \n // Change\n ChangeNew = 110,\n ChangePlanning = 120,\n ChangeImplementation = 130,\n ChangeImplemented = 140,\n ChangeClosed = 150\n}\n\n{\n // Task\n New = 0,\n InProgress = 2,\n NotCompletable = 3,\n Completed = 1,\n \n // Approval\n PendingApproval = 4,\n Blocked = 5,\n Approved = 6,\n Rejected = 7,\n}\n\nTasks\nCommunications\nAttachments \nServiceTargetRelationships\nTimelogs\nRecipientsCc\nFromRelationships\nToRelationships \nSubscriptions\nTicketType\nUser (Enduser)\nAssignedDepartment\nAssignedTeam\nAssignedAgent\nRespondedBy\nResolvedBy\nReopenedBy\nClosedBy\nForm (Selfservice form)\nRequestType\nSource\nStatus\nCategory1\nCategory2\nCategory3\n\n{\n Api = 0,\n Pureservice = 1,\n Selfservice = 2,\n Email = 3,\n SelfserviceLocation = 4\n}\n\n{\n Visible = 0,\n VisibleSilent = 1,\n NotVisible = 2\n}\n\n{\n Home = 0,\n Cellphone = 1,\n Fax = 2,\n Business = 3\n}\n\n{\n None = 0,\n PendingActivate = 1,\n LocationPendingActivate = 2,\n Enduser = 10,\n Agent = 20,\n ZoneAdmin = 25,\n Administrator = 30,\n System = 50\n}\n\n