{
  "aid": "app.helloretriever.com:main-v2",
  "name": "Retriever API",
  "type": "Index",
  "description": "\nThe Retriever API allows you to submit device return orders to Retriever and view their status. If you have any\nquestions or issues, please email us at help@helloretriever.com.\n\nWe also provide a browsable API which allows you to explore and test the API. If you are logged into the\nRetriever portal, you can use your browser to visit any URL from the documentation below to see its return\nvalue and/or submit requests. Note that the browsable API shows real data from your account and allows you to submit\nreal device return orders; you will be billed for any order you submit.\n\n# API Versions\n## V1\nSupports laptop returns from US-based employees. <a href=\"https://app.helloretriever.com/api/v1/docs/\">Click here</a>\n## V2\nUpdate to support the addition of cell phone and monitor returns from US-based employees and laptop and cell phone returns from Canada-based employees. <a href=\"https://app.helloretriever.com/api/v2/docs/\">Click here</a>    \n\n\n<b>*NOTE :</b> For returns from Canada-based employees the return address for the device must be an address within the United States.\n\n# Testing\nIf you would like to test submitting orders via the API without being billed and without the order being shipped, you\ncan submit orders and then manually cancel them via your portal dashboard within 30 minutes. Note that orders are final\nand cannot be cancelled after 30 minutes.\n\n# Rate Limits\nTo ensure reliability and prevent abuse, API read requests (fetching device return order information) are limited to 60\nper minute and 500 per day. Write requests (submitting device return orders) are limited to 600 per minute and 5000 per\nday. A `429 Too Many Requests` response will be returned if the limits are exceeded. These limits should be sufficient\nfor most API usage; please contact us if you have a need for a higher volume of API calls.\n    ",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/app.helloretriever.com/main/v2/apis.json",
  "tags": [
    "app.helloretriever.com",
    "main"
  ],
  "created": "2026-04-01",
  "modified": "2026-04-01",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "app.helloretriever.com:main-v2",
      "name": "Retriever API",
      "description": "\nThe Retriever API allows you to submit device return orders to Retriever and view their status. If you have any\nquestions or issues, please email us at help@helloretriever.com.\n\nWe also provide a browsable API which allows you to explore and test the API. If you are logged into the\nRetriever portal, you can use your browser to visit any URL from the documentation below to see its return\nvalue and/or submit requests. Note that the browsable API shows real data from your account and allows you to submit\nreal device return orders; you will be billed for any order you submit.\n\n# API Versions\n## V1\nSupports laptop returns from US-based employees. <a href=\"https://app.helloretriever.com/api/v1/docs/\">Click here</a>\n## V2\nUpdate to support the addition of cell phone and monitor returns from US-based employees and laptop and cell phone returns from Canada-based employees. <a href=\"https://app.helloretriever.com/api/v2/docs/\">Click here</a>    \n\n\n<b>*NOTE :</b> For returns from Canada-based employees the return address for the device must be an address within the United States.\n\n# Testing\nIf you would like to test submitting orders via the API without being billed and without the order being shipped, you\ncan submit orders and then manually cancel them via your portal dashboard within 30 minutes. Note that orders are final\nand cannot be cancelled after 30 minutes.\n\n# Rate Limits\nTo ensure reliability and prevent abuse, API read requests (fetching device return order information) are limited to 60\nper minute and 500 per day. Write requests (submitting device return orders) are limited to 600 per minute and 5000 per\nday. A `429 Too Many Requests` response will be returned if the limits are exceeded. These limits should be sufficient\nfor most API usage; please contact us if you have a need for a higher volume of API calls.\n    ",
      "image": "",
      "baseURL": "https://app.helloretriever.com",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/app.helloretriever.com/main/v2",
      "version": "v2",
      "tags": [
        "app.helloretriever.com",
        "main"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/app.helloretriever.com/main/v2/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/app.helloretriever.com/main/v2"
        }
      ]
    }
  ]
}