{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","description":"## Overview\n\nTrackops offers a REST API to programmatically access various data throughout the system, and optionally connect your Trackops data to other 3rd party services. Keep in mind that while we do offer API functionality to our customers, it is your responsibility to respect our usage restrictions and responsibilities. Please be a good API citizen and do not abuse or misuse API functionality. If at any time, we determine that you are abusing API privileges, we reserve the right to suspend or permanently revoke API access.\n\nFor questions or assistance related to the developer API, please contact support at [support@trackops.com](https://mailto:support@trackops.com) and we will be able to assist you with implementation specifics.\n\n## Access Points\n\nAccessing the Trackops REST API is as simple as [activating API access](https://support.trackops.com/hc/en-us/articles/212338823), and connecting to a fully qualified API end point via the subdomain on your account.\n\n**Example Access Point (getting a client list):**\n\n`https://{subdomain}.viewcases.com/api/v1/clients`\n\n## Authentication\n\nThe Trackops API is an SSL-only API, meaning that non-SSL connections are not allowed. Access to the API requires an active _Full Access_ employee username, and your company [API Token](https://support.trackops.com/hc/en-us/articles/212338823). Accessing the API on behalf of a _Limited Access_ employees or client contacts is not permitted.\n\nAuthentication takes place in the form of a specially formatted username in the form of \"_{username}/token_\", in conjunction with an API token.\n\n**Example of basic authentication:**\n\n`{username}/token:{api_token}`\n\n**Note:** History logs will be recorded using the user information that corresponds to username supplied. If you need to specifically identify API activity, it is best practice to perform API calls using a separate _Full Access_ employee account that is easy to identify as such.\n\nIf you aren't sure how to test connectivity to the Trackops API, we recommend the use of [cURL](http://en.wikipedia.org/wiki/CURL). cURL is a common cross-platform tool used to connect to transfer data through various protocols.\n\n**Generic Example using cURL:**\n\n`curl -u {username}/token:{api_token} https://{subdomain}.viewcases.com/api/v1/...`\n\n**Specific Example using cURL (fetching a client list):**\n\n`curl -u samspade/token:d29d3136-1251-5041-9e1c-428c77edb64d https://mycompany.viewcases.com/api/v1/clients`\n\n## Rate Limiting\n\nThis API is rate limited, meaning that you must throttle your requests. It is best practice to limit requests to approximately 1 request per second to avoid rate limiting. If too many requests are made at once, you will receive an HTTP [429 Too Many Requests](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_Client_Error) response, along with the supporting error message.\n\n**Tip:** If you routinely require access to many records at once for reporting or other purposes, it is best practice to routinely cache new and updated records to a local data store. For more information, please read about _Caching Collection Data_ below.\n\n## Responses\n\nAll responses from the API are returned in [JSON](http://en.wikipedia.org/wiki/Json) format. A typical response will contain a [200 OK](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_Success) status, indicating a successful response. Should an error occur, the response will contain standard [HTTP Status Codes](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to indicate the problem. In most cases, the response will also include an error message or other information to provide more insight about the error. The most common error is [404 Not Found](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_Client_Error), indicating that the URL you are attempting to access is incorrect or has a typo.\n\n**Note:** All responses that include dates with time (i.e. _timestamp_ fields) are served in [UTC](http://en.wikipedia.org/wiki/UTC). It is up to you to convert times to your own timezone if so desired.\n\n## Collections\n\nCollections are responses that include multiple records. To improve performance and manageability, collections are limited to 100 records per page. You can use the _per_page_ request parameter to limit results to a smaller number, and the _page_ parameter to jump to a specific page of the results.\n\n**Tip:** If a collection is empty, or the amount of records returned is less than the _per_page_ parameter, this indicates there are no more records to fetch based on the specified search criteria.\n\nCollection results can also be sorted in ascending (asc) or descending (desc) order through the use of the _dir_ parameter. By default, collections are always returned in descending order (newest records at the top).\n\n**Example of a Collection Sorted by Direction (sorted ascending)**\n\n`curl -u {username}/token:{api_token} \"https://{subdomain}.viewcases.com/api/v1/case/updates?dir=asc\"`\n\n## Searching Collections\n\nUsing request parameters, you can filter your requests to return a specific subset of records. Each request object has a specific set of available request parameters that can be used. For more information on specific parameters available for a query, examine the documentation for the specific object you are interested in (listed under the Objects section below).\n\n**Note:** All collection based queries recognize the _per_page,_ _page,_ and _dir_ parameters.\n\nPassing invalid request parameters to the resource will result in a [400 Bad Request](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_Client_Error) response.\n\nIf your search query contains strings, they must be [URL encoded](http://en.wikipedia.org/wiki/URL_encoding) for the API to properly parse them.\n\n**Example cURL Request with Parameters:**\n\n`curl -u {username}/token:{api_token} \"https://{subdomain}.viewcases.com/api/v1/clients?name=ACME+Insurance\"`\n\n## Caching Collection Data\n\nThe Trackops REST API is _not_ designed to provide a live interface for your staff, customers, or otherwise from outside the standard Trackops user interface. If you determine that you require data in large quantities, or in a more readily available fashion than the API provides, it is best practice to periodically cache/store your query results to a local store for future use.\n\nFor example, if you routinely require access to thousands of records at a time in order to compile a report, it is best practice to periodically query (e.g. on a daily basis) and store the latest results in a local cache, database, or flat file storage so the information is readily available for your use case.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25604869","team":4630888,"collectionId":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","publishedId":"2sBXc7K4UY","public":true,"publicUrl":"https://developer.trackops.com","privateUrl":"https://go.postman.co/documentation/25604869-d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4580e6"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"4580e6"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4580e6"}}]}},"version":"8.10.1","publishDate":"2026-02-03T19:00:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8bea7fc5ba568da5ffdf07083caea395637dcf8826f6942568d8813b134b1c5e","favicon":"https://trackops.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developer.trackops.com/view/metadata/2sBXc7K4UY"}