{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ee74364f-0d5b-4d0c-89bd-c4b85ff3cbd3","name":"Reputation API","description":"# Overview\n\n<img src=\"https://content.pstmn.io/74768cc6-d4b6-4215-be98-a36200208c22/aW1hZ2UucG5n\" width=\"251\" height=\"46\">\n\nReputation's API offers a seamless pathway for data integration and management. This robust interface allows for smooth integration with the [Reputation platform](https://support.reputation.com/s/?language=en_US).\n\nOur REST APIs enable you to aggregate feedback, assess metrics, and streamline operations within your environment. Explore our documentation, complete with detailed code samples, and endpoint insights.\n\n## **Getting Started**\n\n1. Obtain an API key by contacting your customer success manager.\n    \n2. Discuss additional resources you need so they can guide you through the initial setup and test calls.\n    \n3. Ensure your API key is included in your request headers.\n    \n4. Use our endpoints to access the desired resources and functions.\n    \n\n## What You Should Know\n\n- The Reputation API delivers responses in JSON format. For GET requests, the **Accept** HTTP Header may be necessary, while POST and PUT requests often require the **Content-Type** HTTP Header set to **application/json**.\n    \n- The API is language agnostic, allowing you to use any HTTP client—be it Postman, cURL, or others—for requests.\n    \n\n**For example**: A bash script to list all tenants would follow this structure.\n\n``` bash\n#!/bin/bash \\\nACCESS_TOKEN=\\\"API_KEY\\\" \\\ncurl \\\n    -H \\\"Content-Type: application/json\\\" \\\n    -H \\\"X-API-KEY: $ACCESS_TOKEN\\\" \\\n    -X $ACTION\n    \\\"https://api.reputation.com/v3/tenants\\\"\n\n ```\n\n#### TLS Cipher Policy\n\nOur TLS Cipher Policy outlines a list of approved cryptographic algorithms, known as TLS ciphers, which are used in the Transport Layer Security (TLS) protocol. These ciphers ensure the secure transmission of data by encrypting the communication between a client and server. **To comply with this policy, you must use one of the ciphers listed below:**\n\n```\n- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\n- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\n- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\n- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\n- TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\n- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\n- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\n- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\n- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\n- TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\n- TLS_RSA_WITH_3DES_EDE_CBC_SHA\n- TLS_RSA_WITH_AES_128_CBC_SHA\n- TLS_RSA_WITH_AES_128_GCM_SHA256\n- TLS_RSA_WITH_AES_256_CBC_SHA\n- TLS_RSA_WITH_AES_256_GCM_SHA384\n\n ```\n\n#### Agency API Keys\n\nAn **Agency API key** refers to a distinct type of API key issued to agencies on the Reputation platform, allowing them to manage resources across multiple clients or tenants. Each tenant represents a unique entity or client with its own set of data and configurations.\n\nWhen interacting with the platform using the Agency API key, it's essential to specify the target tenant for each request, by including the **TENANT ID** in the request header. This ensures actions are appropriately scoped and directed to the correct tenant's resources.\n\nThe following example shows a simple bash script to list all locations for a particular tenant.\n\n``` bash\n#!/bin/bash \\\nACCESS_TOKEN=\\\"API_KEY\\\" \\\nTENANT_ID=\\\"TENANT_ID\\\" \\\ncurl \\\n    -H \\\"Content-Type: application/json\\\" \\\n    -H \\\"X-API-KEY: $ACCESS_TOKEN\\\" \\\n    -H \\\"X-TENANT-ID: $TENANT_ID\\\" \\\n    -X $ACTION\n    \\\"https://api.reputation.com/v3/locations\\\"\n\n ```\n\n## Validation\n\nEvery incoming request undergoes validation. If the desired resource is absent, a **404 (Not found)** HTTP status code is returned. Should the validation not pass, a **403 (Forbidden)** status code is issued.\n\nAny validation issues are detailed in the response as a collection of error objects.\n\n## Errors\n\nThe following is a list of error parameters.\n\n<table><tbody><tr><th>Parameter</th><th>Parent</th><th><b>Data Type</b></th><th>Description</th></tr><tr><td><div><code>errors</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Object Array</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>An array of <code>error</code> objects.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>error</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><code>errors</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Object</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>An object containing error details.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>field</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><code>error</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Name of the field which failed validation.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>code</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><code>error</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Validation failure code.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>message</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><code>error</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Message explaining the <code>code</code>.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Status Codes\n\n<table><tbody><tr><th>HTTP Status Code</th><th>Result</th></tr><tr><td><div>200</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Ok</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>400</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Bad Parameters<br><br>Account is locked<br><br>Invalid Parameters<br><br>Missing Parameters<br></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>401</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Unauthorized:<br><br>API Key is invalid<br></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>403</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Forbidden:<br><br>API Key is not permitted the operation<br></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>404</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Resource Not Found:<br><br>Missing Tenant Id<br><br>Missing Location Id<br><br>Missing Source Id<br></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>405</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Action not supported by this method</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>429</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Too many requests. API rate limit exceeded</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>500</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Internal Server Error</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>504</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Timeout</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Pagination\n\nFor endpoints returning multiple results, the user data is paginated, with a default limit set to 20. The response will feature a pagination object containing the subsequent fields:\n\n<table><tbody><tr><th>Parameter</th><th><b>Data Type</b></th><th>Description</th></tr><tr><td><div><code>offset</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Integer</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>This offsets the start of each page by the number specified</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>limit</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Integer</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>next</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>API endpoint that will return the next page of data. If not included, this is the last page of data.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>previous</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>String</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>API endpoint that will return the previous page of data. If not included, this is the first page of data.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Date Range\n\nWhen interacting with endpoints that accommodate date ranges, the response will contain a specific `range` object. This object includes the following fields:\n\n| Field | Description |\n| --- | --- |\n| `range` | The specified date range |\n| `from` | The start date of the range |\n| `to` | The end date of the range |\n\nEach field provides insight into the range used for the data retrieval or filtering in the response.\n\n## Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17280339","collectionId":"ee74364f-0d5b-4d0c-89bd-c4b85ff3cbd3","publishedId":"2s83YWk4kZ","public":true,"publicUrl":"https://apidocs.reputation.com","privateUrl":"https://go.postman.co/documentation/17280339-ee74364f-0d5b-4d0c-89bd-c4b85ff3cbd3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"004F5D"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"004F5D"}}]}},"version":"8.10.1","publishDate":"2023-09-21T10:09:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"US","id":"1d96f473-0b1a-4226-9353-834ed06224df","owner":"17280339","values":[{"key":"baseUrl","value":"https://api.reputation.com/v3","enabled":true,"type":"default"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://reputation.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"},{"label":"US","value":"17280339-1d96f473-0b1a-4226-9353-834ed06224df"}],"canonicalUrl":"https://apidocs.reputation.com/view/metadata/2s83YWk4kZ"}