Trackops 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.
\nFor questions or assistance related to the developer API, please contact support at support@trackops.com and we will be able to assist you with implementation specifics.
\nAccessing the Trackops REST API is as simple as activating API access, and connecting to a fully qualified API end point via the subdomain on your account.
\nExample Access Point (getting a client list):
\nhttps://{subdomain}.viewcases.com/api/v1/clients
The 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. Accessing the API on behalf of a Limited Access employees or client contacts is not permitted.
\nAuthentication takes place in the form of a specially formatted username in the form of \"{username}/token\", in conjunction with an API token.
\nExample of basic authentication:
\n{username}/token:{api_token}
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.
\nIf you aren't sure how to test connectivity to the Trackops API, we recommend the use of cURL. cURL is a common cross-platform tool used to connect to transfer data through various protocols.
\nGeneric Example using cURL:
\ncurl -u {username}/token:{api_token} https://{subdomain}.viewcases.com/api/v1/...
Specific Example using cURL (fetching a client list):
\ncurl -u samspade/token:d29d3136-1251-5041-9e1c-428c77edb64d https://mycompany.viewcases.com/api/v1/clients
This 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 response, along with the supporting error message.
\nTip: 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.
\nAll responses from the API are returned in JSON format. A typical response will contain a 200 OK status, indicating a successful response. Should an error occur, the response will contain standard 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, indicating that the URL you are attempting to access is incorrect or has a typo.
\nNote: All responses that include dates with time (i.e. timestamp fields) are served in UTC. It is up to you to convert times to your own timezone if so desired.
\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.
\nTip: 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.
\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).
\nExample of a Collection Sorted by Direction (sorted ascending)
\ncurl -u {username}/token:{api_token} \"https://{subdomain}.viewcases.com/api/v1/case/updates?dir=asc\"
Using 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).
\nNote: All collection based queries recognize the per_page, page, and dir parameters.
\nPassing invalid request parameters to the resource will result in a 400 Bad Request response.
\nIf your search query contains strings, they must be URL encoded for the API to properly parse them.
\nExample cURL Request with Parameters:
\ncurl -u {username}/token:{api_token} \"https://{subdomain}.viewcases.com/api/v1/clients?name=ACME+Insurance\"
The 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.
\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.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25604869","collectionId":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","publishedId":"2sBXc7K4UY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4580e6"},"publishDate":"2026-02-03T19:00:21.000Z"},"item":[{"name":"Budget Details","item":[{"name":"Get a budget detail","id":"f108c962-184e-44a0-a749-aeca5a2a3d6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"/api/v1/budget_details/:id","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}},"urlObject":{"path":["budget_details",":id"],"host":["/api/v1"],"query":[],"variable":[{"description":{"content":"ID of the budget detail
\n","type":"text/plain"},"type":"any","value":"ID of the budget detail
\n","type":"text/plain"},"key":"id","value":"ID of the case associated with the budget detail
\n","type":"text/plain"},"key":"case","value":"ID of the user associated with the budget detail
\n","type":"text/plain"},"key":"user","value":"ISO date the budget detail was added \"from\"
\n","type":"text/plain"},"key":"added_on_from","value":"ISO date the budget detail was added \"to\"
\n","type":"text/plain"},"key":"added_on_to","value":"Alias of added_on_from
\n","type":"text/plain"},"key":"from","value":"Alias of added_on_to
\n","type":"text/plain"},"key":"to","value":"Up to 100 results will be returned in a single API call
\n","type":"text/plain"},"key":"page","value":"Budget details track budget adjustments on a case, and the associated contact who is responsible for the adjustment.
\nSee Also: Managing the case budget
\n","_postman_id":"68526f38-5407-44e8-814d-3a4e788e718a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}}},{"name":"Case Flags","item":[{"name":"Get a case flag","id":"3581e70a-8e9d-4221-bddf-4e4d86cf1de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"/api/v1/case_flags/:case_flag_id","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}},"urlObject":{"path":["case_flags",":case_flag_id"],"host":["/api/v1"],"query":[],"variable":[{"description":{"content":"ID of the case flag
\n","type":"text/plain"},"type":"any","value":"ID of the case flag
\n","type":"text/plain"},"key":"id","value":"Name of the case flag
\n","type":"text/plain"},"key":"name","value":"Reference or lookup code associated with the case flag
\n","type":"text/plain"},"key":"reference_id","value":"Up to 100 results will be returned in a single API call
\n","type":"text/plain"},"key":"page","value":"Case flags are special colorized tags that indicate special handling on cases.
\nSee also: How to set up case flags
\n","_postman_id":"0dda7cee-cec2-4695-8ad6-00337cbf1aed","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}}},{"name":"Case Regions","item":[{"name":"Get a case region","id":"cc13a24d-a18e-4570-9573-734af73394e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"/api/v1/case_regions/:case_region_id","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}},"urlObject":{"path":["case_regions",":case_region_id"],"host":["/api/v1"],"query":[],"variable":[{"description":{"content":"ID of the case region
\n","type":"text/plain"},"type":"any","value":"ID of the case region
\n","type":"text/plain"},"key":"id","value":"Name of the case region
\n","type":"text/plain"},"key":"name","value":"Reference or lookup code associated with the case region
\n","type":"text/plain"},"key":"reference_id","value":"If the case region is set as default
\n","type":"text/plain"},"key":"is_default","value":"Up to 100 results will be returned in a single API call
\n","type":"text/plain"},"key":"page","value":"Case regions categorize cases by geographical areas or sales territories.
\nSee also: Customizing your case regions
\n","_postman_id":"5a1d04cb-6922-49ba-b53d-7fb83d49c33a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}}},{"name":"Case Requests","item":[{"name":"Case Request Uploads (Files)","item":[{"name":"Get a file upload URL","id":"70bb7748-a8e5-440b-95b5-99883fc7f9b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/api/v1/case/requests/:case_request_id/upload_url?filename=invoice.pdf","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}},"urlObject":{"path":["case","requests",":case_request_id","upload_url"],"host":["/api/v1"],"query":[{"description":{"content":"Name of the file (filename.ext) to be uploaded
\n","type":"text/plain"},"key":"filename","value":"legacy.mpga"}],"variable":[{"description":{"content":"ID of the case request
\n","type":"text/plain"},"type":"any","value":"ID of the case request
\n","type":"text/plain"},"type":"any","value":"ID of the case request
\n","type":"text/plain"},"type":"any","value":"ID of the case request
\n","type":"text/plain"},"key":"id","value":"The case request number
\n","type":"text/plain"},"key":"case_request_number","value":"ID of the client
\n","type":"text/plain"},"key":"client","value":"ID of the client location
\n","type":"text/plain"},"key":"location","value":"ID of the case region
\n","type":"text/plain"},"key":"case_region","value":"ID of the case status
\n","type":"text/plain"},"key":"case_status","value":"ID of the primary client contact
\n","type":"text/plain"},"key":"primary_contact","value":"ID of the primary subject
\n","type":"text/plain"},"key":"primary_subject","value":"Value of reference number 1
\n","type":"text/plain"},"key":"reference_value_1","value":"Value of reference number 2
\n","type":"text/plain"},"key":"reference_value_2","value":"Value of reference number 3
\n","type":"text/plain"},"key":"reference_value_3","value":"ID of the workflow
\n","type":"text/plain"},"key":"workflow","value":"ISO datestamp created from
\n","type":"text/plain"},"key":"created_from","value":"ISO datestamp created to
\n","type":"text/plain"},"key":"created_to","value":"Alias of created_from
\n","type":"text/plain"},"key":"from","value":"Alias of created_to
\n","type":"text/plain"},"key":"to","value":"ISO datestamp updated from
\n","type":"text/plain"},"key":"updated_from","value":"ISO datestamp updated to
\n","type":"text/plain"},"key":"updated_to","value":"Up to 100 results will be returned in a single API call
\n","type":"text/plain"},"key":"page","value":"ID of the case request
\n","type":"text/plain"},"type":"any","value":"Case requests provide an interface new case referrals that may be approved and converted to a case. Case requests may also be declined for various reasons. If you always intend to approve case requests, consider creating cases directly.
\nSee also: What are case requests?
\n","_postman_id":"a23638d0-a2e6-4d5e-8824-b07e2b5c01ab","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}}},{"name":"Case Reviews","item":[{"name":"Get a case review","id":"862668b5-e160-459a-b6e9-63fe68d7f484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"/api/v1/case/reviews/:case_review_id","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"full_access_username"},{"key":"password","value":"api_token/token"}]},"isInherited":true,"source":{"_postman_id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","id":"d8e9da7c-3fc5-47e5-82b5-8c2a4c7576b8","name":"Trackops Developer API","type":"collection"}},"urlObject":{"path":["case","reviews",":case_review_id"],"host":["/api/v1"],"query":[],"variable":[{"description":{"content":"ID of the case review
\n","type":"text/plain"},"type":"any","value":"ID of the case review
\n","type":"text/plain"},"key":"id","value":"ID of the case associated with the reivew
\n","type":"text/plain"},"key":"case","value":"ID of the review (question set) associated with the review
\n","type":"text/plain"},"key":"review","value":"Status (enum) of the review
\n","type":"text/plain"},"key":"status","value":"ID of the user associated with the review
\n","type":"text/plain"},"key":"user","value":"Last name of the user associated with the review
\n","type":"text/plain"},"key":"user_last_name","value":"First name of the user associated with the review
\n","type":"text/plain"},"key":"user_first_name","value":"If the review is auto generated or manually generated
\n","type":"text/plain"},"key":"is_auto_generated","value":"Up to 100 results will be returned in a single API call
\n","type":"text/plain"},"key":"page","value":"