{ "opencollection": "1.0.0", "info": { "name": "Teachworks Availabilities Employees API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Employees", "type": "folder" }, "items": [ { "info": { "name": "List all Employees", "type": "http" }, "http": { "method": "GET", "url": "https://api.teachworks.com/v1/employees", "params": [ { "name": "page", "value": "", "type": "query", "description": "1-based page number for pagination. Defaults to 1." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of records per page. Defaults to 20, maximum 80." } ] }, "docs": "List all Employees" }, { "info": { "name": "Create an Employee", "type": "http" }, "http": { "method": "POST", "url": "https://api.teachworks.com/v1/employees", "body": { "type": "json", "data": "{}" } }, "docs": "Create an Employee" }, { "info": { "name": "Retrieve an Employee", "type": "http" }, "http": { "method": "GET", "url": "https://api.teachworks.com/v1/employees/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Retrieve an Employee" }, { "info": { "name": "Update an Employee", "type": "http" }, "http": { "method": "PUT", "url": "https://api.teachworks.com/v1/employees/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Employee" }, { "info": { "name": "Retrieve Employee Earnings", "type": "http" }, "http": { "method": "GET", "url": "https://api.teachworks.com/v1/employees/:id/earnings", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Retrieve Employee Earnings" }, { "info": { "name": "Retrieve Employee Lesson Totals", "type": "http" }, "http": { "method": "GET", "url": "https://api.teachworks.com/v1/employees/:id/lesson_totals", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Retrieve Employee Lesson Totals" }, { "info": { "name": "Set Employee Status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.teachworks.com/v1/employees/:id/set_status", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Employee Status" }, { "info": { "name": "Set Custom Field Values", "type": "http" }, "http": { "method": "PUT", "url": "https://api.teachworks.com/v1/employees/:id/custom_fields", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Custom Field Values" } ] } ], "bundled": true }