{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ashby API Key Survey Request API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Survey Request",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "surveyRequest.create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ashbyhq.com/surveyRequest.create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint generates a survey request and returns a survey URL. You can send this URL to a candidate to allow them to complete a survey. \n\n**Requires the [`candidatesWrite`](authentication#permissions-surveyrequestcreate) permission.**\n\n**Note that calling this endpoint will not automatically email the survey to the candidate.** It simply creates the request and gives you a URL to share with a candidate.\n"
        },
        {
          "info": {
            "name": "surveyRequest.list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.ashbyhq.com/surveyRequest.list",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists all survey requests.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-surveyRequestList) permission.**\n"
        }
      ]
    }
  ],
  "bundled": true
}