{ "opencollection": "1.0.0", "info": { "name": "Ashby API Key User API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "user.info", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.info", "body": { "type": "json", "data": "{}" } }, "docs": "Get an Ashby user by id\n\n**Requires the [`organizationRead`](authentication#permissions-userinfo) permission.**\n" }, { "info": { "name": "user.list", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.list", "body": { "type": "json", "data": "{}" } }, "docs": "Get a list of all Ashby users.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`organizationRead`](authentication#permissions-userlist) permission.**\n\nThe `globalRole` property in the response specifies the user's access level in Ashby.\nFor more details on the permissions granted with each role, see our [documentation here](https://docs.ashbyhq.com/user-permissions).\n" }, { "info": { "name": "user.search", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.search", "body": { "type": "json", "data": "{}" } }, "docs": "Search for an Ashby user by email address\n\n**Requires the [`organizationRead`](authentication#permissions-usersearch) permission.**\n" }, { "info": { "name": "user.interviewerSettings", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.interviewerSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Get interviewer settings for a user.\n\n**Requires the [`organizationRead`](authentication#permissions-userinfo) permission.**\n" }, { "info": { "name": "user.updateInterviewerSettings", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.updateInterviewerSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Update interviewer settings for a user. \n\nEither limit can be provided, or both can be provided. If only one is provided, the other will remain unchanged. If a limit is provided but set to null, it will be unset.\n\n**Requires the [`organizationWrite`](authentication#permissions-userinfo) permission.**\n" }, { "info": { "name": "user.createInterviewerPause", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.createInterviewerPause", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an interviewer pause for a user. While paused, the user will not be scheduled for interviews.\n\nA user can only have one interviewer pause at a time (whether active or scheduled). Attempting to create a pause when one already exists will return an error.\n\n**Requires the [`organizationWrite`](authentication#permissions-usercreateinterviewerpause) permission.**\n" }, { "info": { "name": "user.listInterviewerPauses", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.listInterviewerPauses", "body": { "type": "json", "data": "{}" } }, "docs": "Lists all active or scheduled interviewer pauses for a user.\n\n**Requires the [`organizationRead`](authentication#permissions-userlistinterviewerpauses) permission.**\n" }, { "info": { "name": "user.deleteInterviewerPause", "type": "http" }, "http": { "method": "POST", "url": "https://api.ashbyhq.com/user.deleteInterviewerPause", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an interviewer pause.\n\n**Requires the [`organizationWrite`](authentication#permissions-userdeleteinterviewerpause) permission.**\n" } ] } ], "bundled": true }