{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1e6d4b16-db58-49bc-8424-f210e610835b","name":"Tempus Research API","description":"The Tempus Research API allows you to programmatically access data stored in Tempus Research with ease. This includes the Synapse (recontacting) service, data collection through Inquest, registry participants with Nexus, and more to come in the future.\n\nThe easiest way to get started with the API is to click the Run in Postman button present at the top of the documentation page and use the Postman App to send requests.\n\n> For ease of use inside Postman, you can store the access token in an [environment variable](https://www.getpostman.com/docs/postman/environments_and_globals/manage_environments) called `bearerToken` and this Collection will automatically use it to make subsequent API calls.\n\nContact the [dev team](mailto:development@tempusdynamics.com) for help setting up or using the API.\n\n* * *\n\n# API Environments\n\nThe Tempus API V2 endpoints support three distinct environments, detailed below.\n\n> **When using Nexus or Event endpoints, data created in one environment will not be accessible in any other environment.**\n\n## Production Environment\n\n`https://api.tempusresearch.com/`\n\nThe production environment should be used for real data only.\n\n## Demo Environment\n\n`https://api-demo.tempusresearch.com/`\n\nThe demo environment is a clean duplicate of the production environment, intended for use with test and demo data.\n\n**PHI should not be submitted to endpoints in this environment.**\n\n## Development Environment\n\n`https://api-dev.tempusresearch.com/`\n\nThe development environment is a sandbox for new features and beta testing. Tempus regularly deploys new releases to this environment, so periodic downtime should be expected.\n\n**PHI should not be submitted to endpoints in this environment.**\n\n# Header Versioning\n\nNewer versions of our existing API endpoints are now implemented using Header Versioning. By setting the `x-api-version` header on a request, you can target a specific version of the API (when available). If the `x-api-version` header is not set, it will be interpreted as targeting version `1.0` of that endpoint. Breaking changes may occur between different versions of an API endpoint, so as a best practice, you should always set the `x-api-version` header when making requests to the Tempus API to ensure that your application is targeting the correct version.\n\n> For security and efficiency concerns, Tempus may periodically retire and deprecate older endpoints. In the event that we make such a determination, we will alert you to update your system to use a newer version of the endpoint (or an equivalent) well in advance.\n\n# MetaData Wrapper\n\n> **Legacy and Synapse endpoints do not utilize metadata wrappers.**\n\nMany API endpoints utilize pagination via a metadata wrapper object when returning arrays of data objects or records (e.g. survey responses). This wrapper object includes high-level statistics about the data requested as well as several utility values to assist with navigating through pages of data. The structure of the metadata wrapper is as follows:\n\n*   `metadata`\n    *   `total` - the total number of records available\n    *   `filteredTotal` - the total number of records to be returned after applying any optional filter parameters\n    *   `limit` - the maximum number of records returned per page; may usually be set in a request using query parameters\n    *   `size` - the number of records returned on the current page\n    *   `skip` - the number of records to skip for pagination purposes; may usually be set in a request using query parameters\n    *   `nextPage` - the pre-generated request URL for the next page of results (if any)\n    *   `previousPage` - the pre-generated request URL for the previous page of results (if any)\n*   `data` - the array of data objects requested\n    \n\n## Sortable Fields\n\nSome endpoints utilizing the metadata wrapper also expose an `orderBy` field that can be used to manually specify a sort order for results. The `orderBy` field may be specified multiple times in a request query to sort by multiple values simultaneously; multiple sorts will be applied in the order they are specified. Each value for the `orderBy` field must be in the format `key~direction` where `key` is the field name to be sorted and `direction` is `asc` for ascending (A to Z or lowest to highest) sort or `desc` for descending (Z to A or highest to lowest) sort. Sorting is also possible for sub-values, such as Nexus [Custom Identifiers](#custom-identifiers), by using dot notation (e.g. `identifiers.unique_id~asc`).\n\n# Response and Error Codes\n\nAll API endpoints will return an HTTP status code in one of the following categories and ranges.\n\n| Name | Range | Description |\n| --- | --- | --- |\n| `Success` | 200-299 | The response was successfully executed with no errors. |\n| `Redirect` | 300-399 | The response is redirecting to a new URL. Endpoints expecting this result will include more details in their description. This result may also be used for deprecated endpoints. |\n| `Client Error` | 400-499 | The request was invalid and has been rejected. This response is often accompanied with an error message object that includes the following fields. |\n| `Server Error` | 500-599 | The request failed due to an unexpected internal error. If an endpoint consistently or repeatedly returns one of these codes, please contact Tempus for assistance. |\n\n## Error Model\n\nExpected client errors will return the following error model in the response:\n\n*   `error` - The general error type.\n*   `error_description` - A specific error message describing why the request was rejected.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3904188","team":16112,"collectionId":"1e6d4b16-db58-49bc-8424-f210e610835b","publishedId":"TVCcZVn8","public":true,"publicUrl":"https://docs.tempusresearch.com","privateUrl":"https://go.postman.co/documentation/3904188-1e6d4b16-db58-49bc-8424-f210e610835b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3273DC"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-11-10T14:25:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"SAMPLE","id":"dada881b-daca-47c3-91a9-97b7d885d11f","owner":"3904188","values":[{"key":"baseUrl","value":"https://api.tempusresearch.com","enabled":true},{"key":"environment","value":"","enabled":true},{"key":"grantType","value":"client_credentials","enabled":true},{"key":"clientId","value":"{{clientId}}","enabled":true},{"key":"clientSecret","value":"{{clientSecret}}","enabled":true},{"key":"circleGuid","value":"{{circleGuid}}","enabled":true},{"key":"surveyId","value":"{{surveyId}}","enabled":true},{"key":"definitionGuid","value":"{{definitionGuid}}","enabled":true},{"key":"eventGuid","value":"{{eventGuid}}","enabled":true},{"key":"eventState","value":"{{eventState}}","enabled":true},{"key":"participantIdentifier","value":"{{participantIdentifier}}","enabled":true},{"key":"project","value":"","enabled":true},{"key":"transactionGuid","value":"","enabled":true},{"key":"bookingGuid","value":"","enabled":true},{"key":"resourceGuid","value":"","enabled":true},{"key":"appointmentGuid","value":"","enabled":true}],"published":true}],"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/26fb5e0a9aed91b1f5abf0cc0a4fa74f98e00e13bcb579e801fab09c3c4df6ea","favicon":"https://res.cloudinary.com/postman/image/upload/v1553876604/team/urrmf0ptjpntkc1wrhzl.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"},{"label":"SAMPLE","value":"3904188-dada881b-daca-47c3-91a9-97b7d885d11f"}],"canonicalUrl":"https://docs.tempusresearch.com/view/metadata/TVCcZVn8"}