Welcome to the Teachworks API! This API allows Teachworks users to build custom integrations to interact with data from their Teachworks accounts.
\nTeachworks provides business management software for education companies. You can find more information on our website here: Teachworks.
\nIf you have questions you can contact us at support@teachworks.com.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10096149","collectionId":"19c0ae42-3421-4c3d-ad33-60c425d4c2d1","publishedId":"SWTABydD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8FCB21"},"publishDate":"2023-11-24T19:56:39.000Z"},"item":[{"name":"General Information","item":[{"name":"Usage Policy","item":[],"id":"bf3922fd-98d0-4004-8898-cd7f4d4c4579","description":"The Teachworks API is intended to be used as an interface to connect a Teachworks account with another software program.
\nThe Teachworks API is not intended for backing up records -- backups can be created within Teachworks using the Excel downloads feature.
\nExcessive requests or retrieving records in a continuous loop is not permitted.
\n","_postman_id":"bf3922fd-98d0-4004-8898-cd7f4d4c4579"},{"name":"Request/Response Format","item":[],"id":"d77d89f0-a1ad-408e-8f4a-63ebcdf54a8c","description":"The default response format is JSON. Requests with a message-body use plain JSON to set or update resource attributes. Successful requests will return a 200 OK HTTP status.
\n","_postman_id":"d77d89f0-a1ad-408e-8f4a-63ebcdf54a8c"},{"name":"Pagination","item":[],"id":"c7092e96-7969-4269-9d62-31e456229355","description":"Requests that return multiple items will be paginated to 20 items by default. This default can be changed using the “per_page” parameter up to a maximum of 80 items.
\nGET /students?per_page=15\nYou can specify further pages with the ?page parameter:
\nGET /students?page=2\nPage number is 1-based and omitting the ?page parameter will return the first page.
\n","_postman_id":"c7092e96-7969-4269-9d62-31e456229355"},{"name":"Order","item":[],"id":"1c8cf455-7472-4f9e-ba0b-6107604c1339","description":"By default results are returned in ascending order (\"asc\") on the primary id column. You can also order results in descending order with the \"direction\" parameter set to \"desc\":
\nGET /students?direction=desc\nOccasionally you might encounter errors when accessing the API. There are four possible types:
\n| Error Code | \nError Type | \n
|---|---|
| 400 Bad Request | \nInvalid request, e.g. using unsupported HTTP method or data has validation errors | \n
| 401 Unauthorized | \nAuthentication or permission error, e.g. incorrect API token | \n
| 403 Forbidden | \nRequests to resources that don't exist or requests that exceed the rate-limit | \n
| 404 Not Found | \nRequests to resources that don't exist or are missing | \n
| 500 Internal Sever Error | \nServer error | \n
Errors return both an appropriate HTTP status code and response object which contains a code, message and data attribute.
\n","event":[{"listen":"prerequest","script":{"id":"a8464bfa-d916-4a37-8a87-00491e5c655c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3811ed55-bdc5-4684-9215-c41c90f9d92d","type":"text/javascript","exec":[""]}}],"_postman_id":"cd0499d7-e645-4ae3-a0c4-df25806f0e28"},{"name":"Rate Limiting","item":[],"id":"90c90cd9-15f2-443f-a7fb-88c12091e3ca","description":"API calls are rate-limited by API token at 4 requests per second.
\n","event":[{"listen":"prerequest","script":{"id":"e8655d00-1316-4a44-9a79-f64e47905b07","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb1c24df-8ddf-474e-a332-be19f6f81e8a","type":"text/javascript","exec":[""]}}],"_postman_id":"90c90cd9-15f2-443f-a7fb-88c12091e3ca"}],"id":"75b553de-816d-40a9-913b-936cd1f6a91a","description":"You can access the Teachworks API at:
\n{{base_url}}\nTeachworks uses API tokens to allow access to the API. You can generate an API token for your Teachworks account by going to the API section on the Integrations & Add-ons page.
\nThe Teachworks API uses bearer authorization and requires an Authorization header containing you API token to be included in each request. The header should use the following format:
\n-H 'Authorization: Token token=api_token'\n\nNote: You must replace \"api_token\" above with your account's API token.
\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail.
\nAPI requests without authentication will also fail.
\n","event":[{"listen":"prerequest","script":{"id":"177d5a72-4560-4394-919f-2a00f8ceaca0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"121c7cba-1d05-45d3-ba45-c24622b413cb","type":"text/javascript","exec":[""]}}],"_postman_id":"7e91c772-f3ba-449a-a27c-e68245c7e94b"},{"name":"Locations","item":[{"name":"Retrieve a Location","id":"ed765a51-0888-4f13-ba3c-5e1e80895b5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/locations/:id","description":"Retrieves a single location
\n","urlObject":{"path":["locations",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"3365950f-23e6-46d9-9d72-7ff5c42e993c","name":"Retrieve a Location","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/locations/:id","host":["{{base_url}}"],"path":["locations",":id"],"variable":[{"key":"id","value":"2"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120103958"},{"key":"X-Request-Id","value":"0474dda8d1ee2fe590f1d88020dcb52f"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.063435"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 15:39:57 GMT"},{"key":"Content-Length","value":"325"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"name\": \"Burlington North\",\n \"address\": \"1421 Walkers Line\",\n \"city\": \"Burlington\",\n \"state\": \"ON\",\n \"zip\": \"L7M4P4\",\n \"spaces\": null,\n \"calendar_color\": \"#1E8F2B\",\n \"is_sublocation\": null,\n \"parent_location_id\": null,\n \"link\": null,\n \"link_enabled\": false,\n \"created_at\": \"2014-02-20T17:53:05Z\",\n \"updated_at\": \"2018-08-15T20:41:22Z\"\n}"}],"_postman_id":"ed765a51-0888-4f13-ba3c-5e1e80895b5b"},{"name":"List all Locations","id":"9742213c-c739-4e9f-a9ef-77e714b3b250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/locations","description":"Returns a list of locations matching the search parameters.
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name | \n
| parent_location_id | \nsearch by parent location id if location is a sub-location | \n
| state | \nsearch by state | \n
| zip | \nsearch by zip | \n
| id[gt] | search where id is greater than |
| id[lt] | search where id is less than |
| id[gte] | search where id is equal to or greater than |
| id[lte] | search where id is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create a location.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| name | Name of location |
| address | Address of location |
| city | City of location |
| state | State of location |
| zip | Zip/postal code of location | \n
| link | URL for location | \n
| link_enabled | Display lesson name as clickable link | \n
| calendar_color | Hex code for calendar color-coding | \n
| display_conflicts | Show conflicts for location with conflict checker | \n
| exclude_from_location_calendar | Don't display location on location calendar | \n
Use this endpoint to update a location.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| name | Name of location |
| address | Address of location |
| city | City of location |
| state | State of location |
| zip | Zip/postal code of location | \n
| link | URL for location | \n
| link_enabled | Display lesson name as clickable link | \n
| calendar_color | Hex code for calendar color-coding | \n
| display_conflicts | Show conflicts for location with conflict checker | \n
| exclude_from_location_calendar | Don't display location on location calendar | \n
Endpoint for viewing locations. Locations are the places where lessons and other events take place.
\n","_postman_id":"f7ef49d0-4869-4a30-9ec0-be2a73c8f230"},{"name":"Services","item":[{"name":"Retrieve a Service","id":"5e610288-5b7f-4da4-81b7-3bdf3089d1f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/services/:id","description":"Retrieve a single service
\n","urlObject":{"path":["services",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"0de1809e-3b72-4358-9a57-7bca7e618c6d","name":"Retrieve a Service","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/services/:id","host":["{{base_url}}"],"path":["services",":id"],"variable":[{"key":"id","value":"89"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120105453"},{"key":"X-Request-Id","value":"f12374ad4e9cb246457b49b6df505d14"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.049591"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 15:54:52 GMT"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 89,\n \"name\": \"Math Tutoring\",\n \"default_cost\": \"25.0\",\n \"default_wage\": \"15.0\",\n \"archived\": null,\n \"created_at\": \"2020-01-28T15:49:35Z\",\n \"updated_at\": \"2020-01-28T15:49:35Z\"\n}"}],"_postman_id":"5e610288-5b7f-4da4-81b7-3bdf3089d1f1"},{"name":"List all Services","id":"a80b2a35-acfe-422f-a46a-044876edb58d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/services","description":"Get a list of all services matching your search parameters
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing services. Services are set when scheduling lessons.
\n","event":[{"listen":"prerequest","script":{"id":"b801466f-cc13-4400-accd-bd4a2e00013b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"738d9ce9-d7aa-4585-82ba-292bec81b749","type":"text/javascript","exec":[""]}}],"_postman_id":"3414c0d8-c562-40e1-b7a7-918d46c533ca"},{"name":"Wage Tiers","item":[{"name":"Retrieve a Wage Tier","id":"b77e2940-2162-43f8-9655-a5b0475c6b28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/wage_tiers/:id","description":"Retrieves a single wage tier
\n","urlObject":{"path":["wage_tiers",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"d06f7099-2648-4908-9d17-ff4cdedaf0b0","name":"Retrieve a Wage Tier","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/wage_tiers/:id","host":["{{base_url}}"],"path":["wage_tiers",":id"],"variable":[{"key":"id","value":"26"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120110456"},{"key":"X-Request-Id","value":"fde7a9ffa0594bfe9512ccd9b9dada81"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.059467"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:04:56 GMT"},{"key":"Content-Length","value":"616"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 26,\n \"name\": \"Year 2\",\n \"created_at\": \"2020-01-28T16:03:07Z\",\n \"updated_at\": \"2020-01-28T16:03:07Z\",\n \"service_wage_tiers\": [\n {\n \"service_id\": 92,\n \"wage_tier_id\": 26,\n \"amount\": \"26.0\",\n \"created_at\": \"2020-01-28T16:03:08Z\",\n \"updated_at\": \"2020-01-28T16:03:08Z\"\n },\n {\n \"service_id\": 90,\n \"wage_tier_id\": 26,\n \"amount\": \"16.0\",\n \"created_at\": \"2020-01-28T16:03:08Z\",\n \"updated_at\": \"2020-01-28T16:03:08Z\"\n },\n {\n \"service_id\": 91,\n \"wage_tier_id\": 26,\n \"amount\": \"19.0\",\n \"created_at\": \"2020-01-28T16:03:08Z\",\n \"updated_at\": \"2020-01-28T16:03:08Z\"\n },\n {\n \"service_id\": 89,\n \"wage_tier_id\": 26,\n \"amount\": \"16.0\",\n \"created_at\": \"2020-01-28T16:03:08Z\",\n \"updated_at\": \"2020-01-28T16:03:08Z\"\n }\n ]\n}"}],"_postman_id":"b77e2940-2162-43f8-9655-a5b0475c6b28"},{"name":"List all Wage Tiers","id":"fa579084-f2f7-45ed-9b42-9357a1fc06f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/wage_tiers","description":"Returns a list of wage tiers that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name | \n
| service_id | \nsearch by the id of the service that this wage tier is associated with | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing and managing wage tiers. Wage tiers can be used to pay teachers at different rates for the same service.
\n","_postman_id":"09cb952f-e5e3-43b2-87fe-ac89af7561ca"},{"name":"Cost Premiums","item":[{"name":"Retrieve a Cost Premium","id":"a28d20c8-fca7-4c57-afb3-e1911c3174ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/cost_premiums/:id","description":"Retrieve a single cost premium
\n","urlObject":{"path":["cost_premiums",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"f3def444-827d-4353-bc86-9c17daa8093c","name":"Retrieve a Cost Premium","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/cost_premiums/:id","host":["{{base_url}}"],"path":["cost_premiums",":id"],"variable":[{"key":"id","value":"5"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120111636"},{"key":"X-Request-Id","value":"699e2d6486064d0238a0a2a3c1ee09a0"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.058987"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:16:35 GMT"},{"key":"Content-Length","value":"147"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5,\n \"name\": \"Travel Premium - 50k\",\n \"amount\": \"15.0\",\n \"wage_amount\": \"15.0\",\n \"created_at\": \"2020-01-28T16:14:58Z\",\n \"updated_at\": \"2020-01-28T16:14:58Z\"\n}"}],"_postman_id":"a28d20c8-fca7-4c57-afb3-e1911c3174ab"},{"name":"List all Cost Premiums","id":"0f1c07e3-5fc6-409a-871a-1a5d87da81ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/cost_premiums","description":"Returns a list of cost premiums that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing cost premiums. Cost premiums can be used for adding an additional cost and wage per lesson.
\n","_postman_id":"c01197bd-c006-45dc-b9b8-c83394648cf3"},{"name":"Employees","item":[{"name":"Retrieve an Employee","id":"302ff8d1-ce8a-4f4b-9dca-a5169f79c4ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/employees/:id","description":"Retrieve a single employee.
\nNote: The URL in the \"photo\" attribute of the response an expiring URL (10 minutes), so if you require long-term use of the image you should use the URL to save the image to your server and load it from there.
\n","urlObject":{"path":["employees",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"268f2585-5d2e-472d-86f4-e5017082f151","name":"Retrieve an Employee","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/employees/:id","host":["{{base_url}}"],"path":["employees",":id"],"variable":[{"key":"id","value":"7099"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120112807"},{"key":"X-Request-Id","value":"7a86ec3958f01cf77d1ca9db181ff189"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.072297"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:28:06 GMT"},{"key":"Content-Length","value":"1399"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 7099,\n \"employee_type\": \"Teacher\",\n \"include_as_teacher\": 0,\n \"first_name\": \"Angela\",\n \"last_name\": \"DeKorne\",\n \"email\": \"adk@teachworks.com\",\n \"mobile_phone\": \"123-123-1234\",\n \"home_phone\": \"\",\n \"address\": \"12 Main Street\",\n \"address_2\": \"\",\n \"city\": \"Kitchener\",\n \"state\": \"ON\",\n \"zip\": \"N2G5P4\",\n \"country\": \"Canada\",\n \"birth_date\": \"1999-12-24\",\n \"hire_date\": \"2020-01-08\",\n \"position\": \"Teacher\",\n \"additional_notes\": \"\",\n \"subjects\": \"English,Biology\",\n \"status\": \"Active\",\n \"time_zone\": null,\n \"wage_type\": \"Service List Wage\",\n \"employee_wage\": null,\n \"wage_tier_id\": null,\n \"work_wage_type\": \"Work List Wage\",\n \"work_wage\": null,\n \"bio\": \"\",\n \"bio_drafted_at\": null,\n \"bio_approved\": \"\",\n \"bio_approved_at\": \"2020-01-28T16:24:54Z\",\n \"photo\": \"\",\n \"email_lesson_reminders\": 0,\n \"sms_lesson_reminders\": 0,\n \"calendar_default_view\": \"month\",\n \"calendar_color\": \"#ED8BF8\",\n \"calendar_color_by\": \"student\",\n \"user_account\": 0,\n \"unviewed\": false,\n \"p_employees\": \"off\",\n \"p_students\": \"off\",\n \"p_services\": \"view\",\n \"p_events\": \"complete\",\n \"p_event_cost\": \"off\",\n \"p_accounting\": \"off\",\n \"p_reports\": \"off\",\n \"p_settings\": \"off\",\n \"p_subscription\": \"off\",\n \"p_student_contact\": \"view\",\n \"p_events_others\": \"off\",\n \"p_events_duration\": \"view\",\n \"p_locations\": \"view\",\n \"p_send_notes\": \"on\",\n \"p_teachers\": \"off\",\n \"p_staff\": \"off\",\n \"p_tasks\": \"off\",\n \"p_event_wage\": \"view\",\n \"p_payroll\": \"off\",\n \"p_documents\": \"on\",\n \"p_integrations\": \"off\",\n \"p_email\": \"off\",\n \"welcome_sent_at\": null,\n \"created_at\": \"2020-01-28T16:24:54Z\",\n \"updated_at\": \"2020-01-28T16:24:54Z\",\n \"custom_fields\": []\n}"}],"_postman_id":"302ff8d1-ce8a-4f4b-9dca-a5169f79c4ac"},{"name":"Retrieve Employee Earnings","id":"58a59586-a1ab-4751-9ca6-e8d2d9041265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/employees/:id/earnings","description":"Returns the total earnings for an employee for the selected filter parameters.
\n| Parameter | \nDescription | \n
|---|---|
| status | \nfilter by lesson status (Scheduled, Attended, Cancelled, Missed) | \n
| status[] | \nfilter by multiple lesson statuses (Scheduled, Attended, Cancelled, Missed).Pass in a separate \"status[]\" parameter for each status. | \n
| date | \nfilter by date the lesson starts on. Use YYYY-MM-DD format for dates.\n |
| date[gt] | filter where date is greater than |
| date[lt] | filter where date is less than |
| date[gte] | filter where date is equal to or greater than |
| date[lte] | filter where date is equal to or less than |
Can return one of the following measures for a teacher's lessons: total duration in minutes, total earnings, or total count. The filters listed below can be applied.
\n| Parameter | \nDescription | \n
|---|---|
| measure | \nthe type of result to measure. Can be duration, earnings, or count. Default is \"count\". | \n
| status | \nfilter by lesson status (Scheduled, Attended, Cancelled, Missed). | \n
| status[] | \nfilter by multiple lesson statuses (Scheduled, Attended, Cancelled, Missed).Pass in a separate \"status[]\" parameter for each status. | \n
| date | \nfilter by date the lesson starts on. Use YYYY-MM-DD format for dates.\n |
| date[gt] | filter where date is greater than |
| date[lt] | filter where date is less than |
| date[gte] | filter where date is equal to or greater than |
| date[lte] | filter where date is equal to or less than |
Returns a list of employees that match the search parameters
\nNote: The URL in the \"photo\" attribute of the response is an expiring URL (10 minutes), so if you require long-term use of the image you should use the URL to save the image to your server and load it from there.
\n| Parameter | Description |
|---|---|
first_name | search by first name |
last_name | search by last name |
email | search by email |
city | search by city |
state | search by state |
zip | search by zip |
status | search by status (Active, Inactive, Prospective) |
subject | search by subject |
id[gt] | search where id is greater than |
id[lt] | search where id is less than |
id[gte] | search where id is equal to or greater than |
id[lte] | search where id is equal to or less than |
page | pass an optional page number for pagination, defaults to page 1 |
per_page | number of records to display per each page, defaults to 20, maximum 50 |
direction | direction to sort by primary id (asc, desc), defaults to asc |
Use this endpoint to create an employee.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| employee_type (Required) | \n\"Teacher\" or \"Staff\" | \n
| include_as_teacher | \nSet to true if employee_type is \"Staff\" and employee also teaches lessons. | \n
| status | \n\"Active\", \"Inactive\" or \"Prospective\". Defaults to \"Active\". | \n
| Email address used for notifications and user accounts | |
| mobile_phone | Mobile phone number |
| home_phone | Home phone number |
| address | Address |
| address_2 | Address line 2 |
| city | City |
| state | State or Province |
| zip | Zip or postal code |
| country | Country |
| additional_notes | Additional notes about the client |
| birth_date | \nBirth date in YYYY-MM-DD format. | \n
| hire_date | \nHire date in YYYY-MM-DD format. | \n
| position | \nPosition or job title | \n
| bio | \nBiographical details that can be displayed in website plugins | \n
| wage_type | \nMethod for calculating wage for lessons. \"Employee Wage\" or \"Service List Wage\". Defaults to \"Service List Wage\". | \n
| employee_wage | \nWage per hour for lessons if wage_type set to \"Employee Wage\". | \n
| wage_tier_id | \nID of Wage Tier if wage_type is \"Service List Wage\" and Wage Tiers are enabled. | \n
| work_wage_type | \nMethod for calculating wage for non-teaching work. \"Employee Wage\" or \"Work List Wage\". Defaults to \"Work List Wage\". | \n
| work_wage | \nWage per hour for non-teaching work if wage_type set to \"Employee Wage\". | \n
| calendar_default_view | \nDefault calendar view of \"month\",\"agendaWeek\", or \"agendaDay\". Defaults to \"month\". | \n
| calendar_color_by | \nColor-code calendar events by \"teacher\",\"student\" or \"location\". Defaults to \"student\". | \n
| calendar_color | \nHex code for events belonging to employee. | \n
| subject_ids | \nArray of IDs of subjects for employee. | \n
| email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
| welcome_email | \nSet to true to send welcome email to employee. | \n
| enable_user_account | \nSet to true to enable user account for employee. | \n
| Teacher User Permissions | \n |
| p_events | \nCalendar events permission. Select one of \"view\", \"complete\", \"manage\". Default: \"complete\". | \n
| p_event_cost | \nEvent Cost permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_events_others | \nOther teacher lesson permission. Select one of \"off\", \"view\". Default: \"off\". | \n
| p_events_duration | \nChange duration permission when p_events is set to \"complete\". Select one of \"view\", \"manage\". Default: \"view\". | \n
| p_student_contact | \nStudent contact information permission. Select one of \"off\", \"view\". Default: \"view\". | \n
| p_send_notes | \nPermission for emailing lesson notes. Select one of \"off\", \"on\". Default: \"on\". | \n
| p_documents | \nPermission if Profile Attachments add-on enabled. Select one of \"off\", \"on\". Default: \"on\". | \n
| Staff User Permissions | \n |
| p_staff | \nStaff permission. Select one of \"off\", \"view\". Default: \"off\". | \n
| p_teachers | \nTeacher permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_students | \nStudent & Family permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_accounting | \nAccounting permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_payroll | \nPayroll permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_services | \nServices permission. Select one of \"off\", \"view\", \"manage\". Default: \"view\". | \n
| p_locations | \nLocations permission. Select one of \"off\", \"view\", \"manage\". Default: \"view\". | \n
| p_events | \nCalendar events permission. Select one of \"off\", \"view\", \"complete\", \"manage\". Default: \"off\". | \n
| p_event_cost | \nCalendar event cost permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_event_wage | \nCalendar event wage (other employees) permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_events_duration | \nChange duration permission when p_events is set to \"complete\". Select one of \"view\", \"manage\". Default: \"view\". | \n
| p_reports | \nReports & analytics permission. Select one of \"off\", \"view\". Default: \"off\". | \n
| p_tasks | \nTasks add-on permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_settings | \nAccount Settings permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_subscription | \nSubscription permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_integrations | \nIntegration settings permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_documents | \nPermission if Profile Attachments add-on enabled. Select one of \"off\", \"on\". Default: \"on\". | \n
| p_email | \nEmail & Schedule Confirmation add-on permission. Select one of \"off\", \"on\". Default: \"off\". | \n
| p_send_notes | \nPermission for emailing lesson notes. Select one of \"off\", \"on\". Default: \"on\". | \n
Use this endpoint to update an employee.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| employee_type (Required) | \n\"Teacher\" or \"Staff\" | \n
| include_as_teacher | \nSet to true if employee_type is \"Staff\" and employee also teaches lessons. | \n
| status | \n\"Active\", \"Inactive\" or \"Prospective\" | \n
| Email address used for notifications and user accounts | |
| mobile_phone | Mobile phone number |
| home_phone | Home phone number |
| address | Address |
| address_2 | Address line 2 |
| city | City |
| state | State or Province |
| zip | Zip or postal code |
| country | Country |
| additional_notes | Additional notes about the client |
| birth_date | \nBirth date in YYYY-MM-DD format. | \n
| hire_date | \nHire date in YYYY-MM-DD format. | \n
| position | \nPosition or job title | \n
| bio | \nBiographical details that can be displayed in website plugins | \n
| wage_type | \nMethod for calculating wage for lessons. \"Employee Wage\" or \"Service List Wage\". Defaults to \"Service List Wage\". | \n
| employee_wage | \nWage per hour for lessons if wage_type set to \"Employee Wage\". | \n
| wage_tier_id | \nID of Wage Tier if wage_type is \"Service List Wage\" and Wage Tiers are enabled. | \n
| work_wage_type | \nMethod for calculating wage for non-teaching work. \"Employee Wage\" or \"Work List Wage\". Defaults to \"Work List Wage\". | \n
| work_wage | \nWage per hour for non-teaching work if wage_type set to \"Employee Wage\". | \n
| calendar_default_view | \nDefault calendar view of \"month\",\"agendaWeek\", or \"agendaDay\". Defaults to \"month\". | \n
| calendar_color_by | \nColor-code calendar events by \"teacher\",\"student\" or \"location\". Defaults to \"student\". | \n
| calendar_color | \nHex code for events belonging to employee. | \n
| subject_ids | \nArray of IDs of subjects for employee. | \n
| email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
| welcome_email | \nSet to true to send welcome email to employee. | \n
| enable_user_account | \nSet to true to enable user account for employee. | \n
| Teacher User Permissions | \n |
| p_events | \nCalendar events permission. Select one of \"view\", \"complete\", \"manage\". Default: \"complete\". | \n
| p_event_cost | \nEvent Cost permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_events_others | \nOther teacher lesson permission. Select one of \"off\", \"view\". Default: \"off\". | \n
| p_events_duration | \nChange duration permission when p_events is set to \"complete\". Select one of \"view\", \"manage\". Default: \"view\". | \n
| p_student_contact | \nStudent contact information permission. Select one of \"off\", \"view\". Default: \"view\". | \n
| p_send_notes | \nPermission for emailing lesson notes. Select one of \"off\", \"on\". Default: \"on\". | \n
| p_documents | \nPermission if Profile Attachments add-on enabled. Select one of \"off\", \"on\". Default: \"on\". | \n
| Staff User Permissions | \n |
| p_staff | \nStaff permission. Select one of \"off\", \"view\". Default: \"off\". | \n
| p_teachers | \nTeacher permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_students | \nStudent & Family permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_accounting | \nAccounting permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_payroll | \nPayroll permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_services | \nServices permission. Select one of \"off\", \"view\", \"manage\". Default: \"view\". | \n
| p_locations | \nLocations permission. Select one of \"off\", \"view\", \"manage\". Default: \"view\". | \n
| p_events | \nCalendar events permission. Select one of \"off\", \"view\", \"complete\", \"manage\". Default: \"off\". | \n
| p_event_cost | \nCalendar event cost permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_event_wage | \nCalendar event wage (other employees) permission. Select one of \"off\", \"view\", \"manage\". Default: \"off\". | \n
| p_events_duration | \nChange duration permission when p_events is set to \"complete\". Select one of \"view\", \"manage\". Default: \"view\". | \n
| p_reports | \nReports & analytics permission. Select one of \"off\", \"view\". Default: \"off\". | \n
| p_tasks | \nTasks add-on permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_settings | \nAccount Settings permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_subscription | \nSubscription permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_integrations | \nIntegration settings permission. Select one of \"off\", \"manage\". Default: \"off\". | \n
| p_documents | \nPermission if Profile Attachments add-on enabled. Select one of \"off\", \"on\". Default: \"on\". | \n
| p_email | \nEmail & Schedule Confirmation add-on permission. Select one of \"off\", \"on\". Default: \"off\". | \n
| p_send_notes | \nPermission for emailing lesson notes. Select one of \"off\", \"on\". Default: \"on\". | \n
Set's the status of the employee. Valid statuses are \"Prospective\", \"Active\" and \"Inactive\".
\n","urlObject":{"path":["employees",":id","set_status"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"ef949c2b-181e-43ec-bb31-7737887735b9","type":"string","value":"","key":"id"}]}},"response":[{"id":"44f09270-09b8-49ee-b2df-d644d09a2cb3","name":"Set Employee Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\t\"employee\": \n {\n\t \"status\": \"Inactive\"\n\t}\n}"},"url":{"raw":"{{base_url}}/employees/:id/set_status","host":["{{base_url}}"],"path":["employees",":id","set_status"],"variable":[{"key":"id","value":"7099"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120112807"},{"key":"X-Request-Id","value":"7a86ec3958f01cf77d1ca9db181ff189"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.072297"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:28:06 GMT"},{"key":"Content-Length","value":"1399"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 7099,\n \"employee_type\": \"Teacher\",\n \"include_as_teacher\": 0,\n \"first_name\": \"Angela\",\n \"last_name\": \"DeKorne\",\n \"email\": \"adk@teachworks.com\",\n \"mobile_phone\": \"123-123-1234\",\n \"home_phone\": \"\",\n \"address\": \"12 Main Street\",\n \"address_2\": \"\",\n \"city\": \"Kitchener\",\n \"state\": \"ON\",\n \"zip\": \"N2G5P4\",\n \"country\": \"Canada\",\n \"birth_date\": \"1999-12-24\",\n \"hire_date\": \"2020-01-08\",\n \"position\": \"Teacher\",\n \"additional_notes\": \"\",\n \"subjects\": \"English,Biology\",\n \"status\": \"Inactive\",\n \"time_zone\": null,\n \"wage_type\": \"Service List Wage\",\n \"employee_wage\": null,\n \"wage_tier_id\": null,\n \"work_wage_type\": \"Work List Wage\",\n \"work_wage\": null,\n \"bio\": \"\",\n \"bio_drafted_at\": null,\n \"bio_approved\": \"\",\n \"bio_approved_at\": \"2020-01-28T16:24:54Z\",\n \"photo\": \"\",\n \"email_lesson_reminders\": 0,\n \"sms_lesson_reminders\": 0,\n \"calendar_default_view\": \"month\",\n \"calendar_color\": \"#ED8BF8\",\n \"calendar_color_by\": \"student\",\n \"user_account\": 0,\n \"unviewed\": false,\n \"p_employees\": \"off\",\n \"p_students\": \"off\",\n \"p_services\": \"view\",\n \"p_events\": \"complete\",\n \"p_event_cost\": \"off\",\n \"p_accounting\": \"off\",\n \"p_reports\": \"off\",\n \"p_settings\": \"off\",\n \"p_subscription\": \"off\",\n \"p_student_contact\": \"view\",\n \"p_events_others\": \"off\",\n \"p_events_duration\": \"view\",\n \"p_locations\": \"view\",\n \"p_send_notes\": \"on\",\n \"p_teachers\": \"off\",\n \"p_staff\": \"off\",\n \"p_tasks\": \"off\",\n \"p_event_wage\": \"view\",\n \"p_payroll\": \"off\",\n \"p_documents\": \"on\",\n \"p_integrations\": \"off\",\n \"p_email\": \"off\",\n \"welcome_sent_at\": null,\n \"created_at\": \"2020-01-28T16:24:54Z\",\n \"updated_at\": \"2020-01-28T16:24:54Z\",\n \"custom_fields\": []\n}"}],"_postman_id":"d1b339b8-8695-4f98-b7f3-8b61afba04e5"},{"name":"Set Custom Field Values Copy","id":"dfd7e7d1-1e6d-4f41-93f7-854a68a34902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{base_url}}/employees/:id/custom_fields","description":"The \"Custom Profile Fields\" add-on in Teachworks allows companies to create custom fields for all of their employees. When an employee is created, custom field records are auto-generated with empty values. After an employee has been created you can update the custom field values using this endpoint.
\nYou can get the field_id for each custom field from the employee object returned after creating, updating or retrieving an employee.
\nThis endpoint allows you to set the values for up to 10 custom fields at once.
\nThe JSON response includes an array with any errors for specific records, and an array of updated records.
\nYou should refer to the settings for this add-on in Teachworks to determine the accepted values for certain custom fields (ie. for select menus, radio buttons, etc.).
\n| Argument | \nDescription | \n
|---|---|
| custom_fields | Array containing list of hashes with the following attributes |
| » field_id | ID of the custom field |
| » value | Value of the custom field For mulit-select values, submit as a comma separated array (ie. [\"value1\",\"value2\"]). |
Endpoint for viewing teachers & administrative staff
\n","_postman_id":"d43b601e-614e-48d4-9cf4-3764aca3a1b1"},{"name":"Customers","item":[{"name":"Retrieve a Customer","id":"cf4c823b-8fb9-495f-9798-2ac86b1c1dbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/customers/:id","description":"Retrieve a single customer profile (ie. family or independent student). Note: Use the List Students endpoint to retrieve student profiles.
\n","urlObject":{"path":["customers",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"3f78bcaa-d9ba-4e6c-b0b2-2b0f8304582e","name":"Retrieve a Customer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/customers/:id","host":["{{base_url}}"],"path":["customers",":id"],"variable":[{"key":"id","value":"13652"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120113641"},{"key":"X-Request-Id","value":"88a339914f99eee55e9bc07c058f1069"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.036316"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:36:40 GMT"},{"key":"Content-Length","value":"740"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 13652,\n \"customer_type\": \"family\",\n \"salutation\": \"\",\n \"first_name\": \"Frank & Tina\",\n \"last_name\": \"Vanderwier\",\n \"email\": \"ftv@teachworks.com\",\n \"additional_email\": \"\",\n \"home_phone\": \"123-123-1234\",\n \"mobile_phone\": \"123-1234\",\n \"work_phone\": \"\",\n \"address\": \"5 River Street\",\n \"address_2\": \"\",\n \"city\": \"Kitchener\",\n \"state\": \"ON\",\n \"zip\": \"N3B 4S7\",\n \"country\": \"Canada\",\n \"additional_notes\": \"\",\n \"status\": \"Active\",\n \"time_zone\": null,\n \"email_lesson_reminders\": 1,\n \"email_lesson_notes\": 1,\n \"sms_lesson_reminders\": 0,\n \"user_account\": 0,\n \"stripe_id\": null,\n \"unviewed\": false,\n \"is_family_contact\": false,\n \"family_customer_id\": null,\n \"last_invoice_date\": null,\n \"welcome_sent_at\": null,\n \"created_at\": \"2020-01-28T16:33:19Z\",\n \"updated_at\": \"2020-01-28T16:33:19Z\",\n \"custom_fields\": [],\n \"students_attributes\": {}\n}"}],"_postman_id":"cf4c823b-8fb9-495f-9798-2ac86b1c1dbf"},{"name":"List all Customers","id":"6b4944e1-3428-4c73-885e-55eea1dae479","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/customers","description":"Returns a list of customer profiles (family and independent student) that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| first_name | \nsearch by first name | \n
| last_name | \nsearch by last name | \n
| search by email | \n|
| phone_number | \nsearch by phone number | \n
| city | \nsearch by city | \n
| state | \nsearch by state | \n
| zip | \nsearch by zip | \n
| country | \nsearch by country | \n
| type | \nsearch by customer type (family or independent) | \n
| status | \nsearch by status (Active, Inactive, Prospective) | \n
| id[gt] | search where id is greater than |
| id[lt] | search where id is less than |
| id[gte] | search where id is equal to or greater than |
| id[lte] | search where id is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Can return one of the following measures for a customer's lessons: total duration in minutes or total count. The response will include the customer id, total, and total for each status. The filters listed below can be applied.
\n| Parameter | \nDescription | \n
|---|---|
| measure | \nthe type of result to measure. Can be duration or count. Default is \"count\". | \n
| status | \nfilter by lesson status (Scheduled, Attended, Cancelled, Missed). | \n
| status[] | \nfilter by multiple lesson statuses (Scheduled, Attended, Cancelled, Missed).Pass in a separate \"status[]\" parameter for each status. | \n
| date | \nfilter by date the lesson starts on. Use YYYY-MM-DD format for dates.\n |
| date[gt] | filter where date is greater than |
| date[lt] | filter where date is less than |
| date[gte] | filter where date is equal to or greater than |
| date[lte] | filter where date is equal to or less than |
Use this endpoint to create a family. Families are customers that have child students and are billed for the fees associated with their students.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| salutation | Accepted values: 'Mr.', 'Mrs.', 'Ms.', 'Miss', 'Mr. & Mrs.', 'Dr.' |
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| Primary email address used for notifications and user accounts | |
| additional_email | Additional email addresses. Comma separate for multiple addresses. |
| home_phone | Home phone number |
| mobile_phone | Mobile phone number |
| work_phone | Work phone number |
| address | Address |
| address_2 | Address line 2 |
| city | City |
| state | State or Province |
| zip | Zip or postal code |
| country | Country |
| additional_notes | Additional notes about the client |
| status | Active, Inactive or Prospective |
| email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| email_lesson_notes | Set to true to enable email lesson notes. Email address required if enabled. |
| sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| stripe_id | Stripe customer ID for payment processing |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
Use this endpoint to create an independent student. Independent students are students that are billed directly.
\nCreating an independent student will create a customer record and an associated student record.
\nArguments
\n| Argument | Description |
|---|---|
salutation | Accepted values: 'Mr.', 'Mrs.', 'Ms.', 'Miss', 'Mr. & Mrs.', 'Dr.' |
first_name (Required) | First Name |
last_name (Required) | Last Name |
email | Primary email address used for notifications and user accounts |
additional_email | Additional email addresses. Comma separate for multiple addresses. |
home_phone | Home phone number |
mobile_phone | Mobile phone number |
work_phone | Work phone number |
address | Address |
address_2 | Address line 2 |
city | City |
state | State or Province |
zip | Zip or postal code |
country | Country |
additional_notes | Additional notes about the client |
status | Active, Inactive or Prospective |
stripe_id | Stripe customer ID for payment processing |
unviewed | Set to true to mark family profile as \"New\" in Teachworks |
students_attributes | Array with hash of the following: |
» school | Student's school |
» grade | Student's grade level |
» calendar_color | Hex color code (ie. #800B00) for student's lessons on calendar. Will be set automatically if no value is entered. |
» birth_date | Student birth date in YYYY-MM-DD format. |
» start_date | Student start date in YYYY-MM-DD format |
» billing_method | Student billing method. Options: 'Service List Cost','Student Cost','Package', 'Flat Fee' |
» student_cost | Student cost per hour (if billing_method set to 'Student Cost') |
» cost_premium_id | ID of cost premium applied to student lessons |
» discount_rate | Discount rate percentage applied to student lessons (Accepted values: 0 – 100) |
» email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
» email_lesson_notes | Set to true to enable email lesson notes. Email address required if enabled. |
» sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
» standard_subject_ids | Array of IDs of subjects for student |
» default_location_id | ID of default location for student |
» default_teacher_ids | Array of IDs of default teachers for student |
» default_service_ids | Array of IDs of default services for student |
» student_group_ids | Array of IDs of student groups |
The \"Custom Profile Fields\" add-on in Teachworks allows companies to create custom fields for all of their customers. When a customer is created, custom field records are auto-generated with empty values. After a customer has been created you can update the custom field values using this endpoint.
\nYou can get the field_id for each custom field from the customer object returned after creating, updating or retrieving a student.
\nThis endpoint allows you to set the values for up to 10 custom fields at once.
\nThe JSON response includes an array with any errors for specific records, and an array of updated records.
\nYou should refer to the settings for this add-on in Teachworks to determine the accepted values for certain custom fields (ie. for select menus, radio buttons, etc.).
\n| Argument | \nDescription | \n
|---|---|
| custom_fields | Array containing list of hashes with the following attributes |
| » field_id | ID of the custom field |
| » value | Value of the custom field For mulit-select values, submit as a comma separated array (ie. [\"value1\",\"value2\"]). |
Update an existing family.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| salutation | Accepted values: 'Mr.', 'Mrs.', 'Ms.', 'Miss', 'Mr. & Mrs.', 'Dr.' |
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| Primary email address used for notifications and user accounts | |
| additional_email | Additional email addresses. Comma separate for multiple addresses. |
| home_phone | Home phone number |
| mobile_phone | Mobile phone number |
| work_phone | Work phone number |
| address | Address |
| address_2 | Address line 2 |
| city | City |
| state | State or Province |
| zip | Zip or postal code |
| country | Country |
| additional_notes | Additional notes about the client |
| status | Active, Inactive or Prospective |
| email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| email_lesson_notes | Set to true to enable email lesson notes. Email address required if enabled. |
| sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| stripe_id | Stripe customer ID for payment processing |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
Update an existing independent student.
\nThis will update the customer record and associated student record.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| salutation | Accepted values: 'Mr.', 'Mrs.', 'Ms.', 'Miss', 'Mr. & Mrs.', 'Dr.' |
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| Primary email address used for notifications and user accounts | |
| additional_email | Additional email addresses. Comma separate for multiple addresses. |
| home_phone | Home phone number |
| mobile_phone | Mobile phone number |
| work_phone | Work phone number |
| address | Address |
| address_2 | Address line 2 |
| city | City |
| state | State or Province |
| zip | Zip or postal code |
| country | Country |
| additional_notes | Additional notes about the client |
| status | Active, Inactive or Prospective |
| stripe_id | Stripe customer ID for payment processing |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
| students_attributes | Array with hash of the following: |
| » school | Student's school |
| » grade | Student's grade level |
| » calendar_color | Hex color code (ie. #800B00) for student's lessons on calendar. Will be set automatically if no value is entered. |
| » birth_date | Student birth date in YYYY-MM-DD format. |
| » start_date | Student start date in YYYY-MM-DD format |
| » billing_method | Student billing method. Options: 'Service List Cost','Student Cost','Package', 'Flat Fee' |
| » student_cost | Student cost per hour (if billing_method set to 'Student Cost') |
| » cost_premium_id | ID of cost premium applied to student lessons |
| » discount_rate | Discount rate percentage applied to student lessons (Accepted values: 0 – 100) |
| » email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| » email_lesson_notes | Set to true to enable email lesson notes. Email address required if enabled. |
| » sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| » standard_subject_ids | Array of IDs of subjects for student |
| » default_location_id | ID of default location for student |
| » default_teacher_ids | Array of IDs of default teachers for student |
| » default_service_ids | Array of IDs of default services for student |
| » student_group_ids | Array of IDs of student groups |
Endpoint for viewing and managing customers. There are two types of customers in Teachworks: Families & Independent Students.\nFamilies are customers that have child students and are billed for the fees associated with those students.\nIndependent students are students that are billed directly.
\n","_postman_id":"e3dba8ea-e7f4-4b1b-8963-36bc65acbbfa"},{"name":"Students","item":[{"name":"Retrieve a Student","id":"6caebee2-1df6-4dca-af55-d6f777fcf424","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/students/:id","description":"Retrieves a single student
\n","urlObject":{"path":["students",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"22d7fb7e-a3ab-4a2d-8fac-e7491ee1517b","name":"Retrieve a Student","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/students/:id","host":["{{base_url}}"],"path":["students",":id"],"variable":[{"key":"id","value":"11386"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120113950"},{"key":"X-Request-Id","value":"5b430792f6c0ba2d19478bdd6154405b"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.078370"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:39:49 GMT"},{"key":"Content-Length","value":"792"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 11386,\n \"customer_id\": 13652,\n \"student_type\": \"child\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Vanderwier\",\n \"email\": \"\",\n \"additional_email\": null,\n \"home_phone\": \"\",\n \"mobile_phone\": \"\",\n \"birth_date\": \"2010-01-30\",\n \"start_date\": \"2020-01-15\",\n \"school\": \"Mapleview Elementary\",\n \"grade\": \"\",\n \"additional_notes\": \"\",\n \"calendar_color\": \"#F5C6B1\",\n \"default_location_id\": 95,\n \"subjects\": \"Math\",\n \"status\": \"Active\",\n \"time_zone\": null,\n \"billing_method\": \"Service List Cost\",\n \"student_cost\": null,\n \"cost_premium_id\": null,\n \"discount_rate\": null,\n \"email_lesson_reminders\": 0,\n \"email_lesson_notes\": 0,\n \"sms_lesson_reminders\": 0,\n \"user_account\": 0,\n \"unviewed\": false,\n \"welcome_sent_at\": null,\n \"created_at\": \"2020-01-28T16:34:21Z\",\n \"updated_at\": \"2020-01-28T16:34:21Z\",\n \"custom_fields\": [\n {\n\t\t\t\"field_id\": 15199,\n\t\t\t\"name\": \"Learning Goals\",\n\t\t\t\"value\": \"Algebra proficiency\"\n\t\t}\n ],\n \"default_teachers\": [\n {\n \"id\": 7099,\n \"first_name\": \"Angela\",\n \"last_name\": \"DeKorne\"\n }\n ],\n \"default_services\": [\n {\n \"id\": 1,\n \"name\": \"Math Tutoring\"\n }\n ]\n}"}],"_postman_id":"6caebee2-1df6-4dca-af55-d6f777fcf424"},{"name":"Retrieve Student Lesson Totals","id":"41a05745-1b9b-4fc6-83c4-3bc734eabccd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/students/:id/lesson_totals","description":"Can return one of the following measures for a student's lessons: total duration in minutes or total count. The response will include the student id, total, and total for each status. The filters listed below can be applied.
\n| Parameter | \nDescription | \n
|---|---|
| measure | \nthe type of result to measure. Can be duration or count. Default is \"count\". | \n
| status | \nfilter by lesson status (Scheduled, Attended, Cancelled, Missed). | \n
| status[] | \nfilter by multiple lesson statuses (Scheduled, Attended, Cancelled, Missed).Pass in a separate \"status[]\" parameter for each status. | \n
| date | \nfilter by date the lesson starts on. Use YYYY-MM-DD format for dates.\n |
| date[gt] | filter where date is greater than |
| date[lt] | filter where date is less than |
| date[gte] | filter where date is equal to or greater than |
| date[lte] | filter where date is equal to or less than |
Returns a list of students that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| customer_id | \nsearch by customer id | \n
| first_name | \nsearch by first name | \n
| last_name | \nsearch by last name | \n
| search by email | \n|
| phone_number | \nsearch by phone number | \n
| school | \nsearch by school | \n
| grade | \nsearch by grade | \n
| subject | \nsearch by subject | \n
| type | \nsearch by customer type (family or independent) | \n
| status | \nsearch by status (Active, Inactive, Prospective) | \n
| id[gt] | search where id is greater than |
| id[lt] | search where id is less than |
| id[gte] | search where id is equal to or greater than |
| id[lte] | search where id is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create a child student. Child students belong to a family their fees are billed to the family.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| customer_id | ID of customer/family that the student belongs to |
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| Primary email address used for notifications and user accounts | |
| home_phone | Home phone number |
| mobile_phone | Mobile phone number |
| additional_notes | Additional notes about the client |
| status | Active, Inactive or Prospective |
| school | Student's school |
| grade | Student's grade level |
| calendar_color | Hex color code (ie. #800B00) for student's lessons on calendar. Will be set automatically if no value is entered. |
| birth_date | Student birth date in YYYY-MM-DD format. |
| start_date | Student start date in YYYY-MM-DD format |
| billing_method | Student billing method. Options: 'Service List Cost','Student Cost','Package', 'Flat Fee' |
| student_cost | Student cost per hour (if billing_method set to 'Student Cost') |
| cost_premium_id | ID of cost premium applied to student lessons |
| discount_rate | Discount rate percentage applied to student lessons (Accepted values: 0 – 100) |
| email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| email_lesson_notes | Set to true to enable email lesson notes. Email address required if enabled. |
| sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| standard_subject_ids | Array of IDs of standard subjects for student |
| default_location_id | ID of default location for student |
| default_teacher_ids | Array of IDs of default teachers for student |
| default_service_ids | Array of IDs of default services for student |
| student_group_ids | Array of IDs of student groups |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
Independent Students are added using the following Customers endpoint: Create Independent Student
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"cbf92a49-7328-47dd-8534-1312a1cbbcf1"},{"name":"Set Custom Field Values","id":"20359fe0-17d0-4ca8-8e17-e31680f91792","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{base_url}}/students/:id/custom_fields","description":"The \"Custom Profile Fields\" add-on in Teachworks allows companies to create custom fields for all of their students. When a student is created, custom field records are auto-generated with empty values. After a student has been created you can update the custom field values using this endpoint.
\nYou can get the field_id for each custom field from the student object returned after creating, updating or retrieving a student.
\nThis endpoint allows you to set the values for up to 10 custom fields at once.
\nThe JSON response includes an array with any errors for specific records, and an array of updated records.
\nYou should refer to the settings for this add-on in Teachworks to determine the accepted values for certain fields (ie. for select menus, radio buttons, etc.).
\n| Argument | \nDescription | \n
|---|---|
| custom_fields | Array containing list of hashes with the following attributes |
| » field_id | ID of the custom field |
| » value | Value of the custom field. For mulit-select values, submit as a comma separated array (ie. [\"value1\",\"value2\"]). |
Use this endpoint to update an existing child student.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| customer_id | ID of customer/family that the student belongs to |
| first_name (Required) | First Name |
| last_name (Required) | Last Name |
| Primary email address used for notifications and user accounts | |
| home_phone | Home phone number |
| mobile_phone | Mobile phone number |
| additional_notes | Additional notes about the client |
| status | Active, Inactive or Prospective |
| school | Student's school |
| grade | Student's grade level |
| calendar_color | Hex color code (ie. #800B00) for student's lessons on calendar. Will be set automatically if no value is entered. |
| birth_date | Student birth date in YYYY-MM-DD format. |
| start_date | Student start date in YYYY-MM-DD format |
| billing_method | Student billing method. Options: 'Service List Cost','Student Cost','Package', 'Flat Fee' |
| student_cost | Student cost per hour (if billing_method set to 'Student Cost') |
| cost_premium_id | ID of cost premium applied to student lessons |
| discount_rate | Discount rate percentage applied to student lessons (Accepted values: 0 – 100) |
| email_lesson_reminders | Set to true to enable email lesson reminders. Email address required if enabled. |
| email_lesson_notes | Set to true to enable email lesson notes. Email address required if enabled. |
| sms_lesson_reminders | Set to true to enable SMS lesson reminders. Mobile phone required if enabled. |
| standard_subject_ids | Array of IDs of subjects for student |
| default_location_id | ID of default location for student |
| default_teacher_ids | Array of IDs of default teachers for student |
| default_service_ids | Array of IDs of default services for student |
| student_group_ids | Array of IDs of student groups |
| unviewed | Set to true to mark family profile as \"New\" in Teachworks |
Independent Students are added using the following Customers endpoint: Update Independent Student
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"c3d6a792-f2c6-4a2d-9372-3ccb9c188dd7"}],"id":"72799a28-6914-489b-94e5-45c5d0e6c38a","description":"Endpoint for viewing and managing students. In Teachworks students can be either Child Students or Independent Students. Child students belong to a family and the family is billed for their lesson fees. Independent students are billed directly and can be added throught the Customers endpoint.
\n","_postman_id":"72799a28-6914-489b-94e5-45c5d0e6c38a"},{"name":"Subjects","item":[{"name":"Retrieve a Subject","id":"e1933216-d3ab-45f7-9c2a-0b95d3e95e7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/subjects/:id","description":"Retrieve a single standard subject by id
\n","urlObject":{"path":["subjects",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"8167846b-ba12-4334-9f50-6616f7f5d9dd","name":"Retrieve a Subject","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/subjects/:id","host":["{{base_url}}"],"path":["subjects",":id"],"variable":[{"key":"id","value":"89"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120105453"},{"key":"X-Request-Id","value":"f12374ad4e9cb246457b49b6df505d14"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.049591"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 15:54:52 GMT"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 89,\n \"name\": \"French\",\n \"description\": null,\n \"created_at\": \"2020-01-28T15:49:35Z\",\n \"updated_at\": \"2020-01-28T15:49:35Z\"\n}"}],"_postman_id":"e1933216-d3ab-45f7-9c2a-0b95d3e95e7b"},{"name":"List all Subjects","id":"e6469a6b-66b4-4aa4-a6ae-d05c41fbb646","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/subjects","description":"Get a list of all standard subjects matching your search parameters
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name (will return partial matches) | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing subjects.
\n","event":[{"listen":"prerequest","script":{"id":"ca35ed30-7b36-481a-9276-8c213555c267","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc27203d-4f3b-4f9c-9bb8-5a920c708320","type":"text/javascript","exec":[""]}}],"_postman_id":"d9520eb4-92a5-4b18-af32-f934bc0a1278"},{"name":"Student Groups","item":[{"name":"Retrieve a Student Group","id":"34c4447b-ed96-4044-a664-74083d9205e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/student_groups/:id","description":"Retrieve a single standard subject by id
\n","urlObject":{"path":["student_groups",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"1b4e25c9-c93d-4f8c-95fb-46c6fae210a8","name":"Retrieve a Student Group","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/student_groups/:id","host":["{{base_url}}"],"path":["student_groups",":id"],"variable":[{"key":"id","value":"89"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120105453"},{"key":"X-Request-Id","value":"f12374ad4e9cb246457b49b6df505d14"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.049591"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 15:54:52 GMT"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12,\n \"name\": \"SAT Bootcamp\",\n \"created_at\": \"2021-01-28T15:49:35Z\",\n \"updated_at\": \"2021-01-28T15:49:35Z\"\n}"}],"_postman_id":"34c4447b-ed96-4044-a664-74083d9205e9"},{"name":"List all Student Groups","id":"bbe3efd9-f1d8-4a38-95d9-2be8f4494aa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/student_groups","description":"Get a list of all student groups matching your search parameters
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name (will return partial matches) | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing student groups from the Student Groups add-on.
\n","event":[{"listen":"prerequest","script":{"id":"9ada2970-275c-448e-b786-07dcea7743e8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d7123799-fbe7-4980-9e7a-8257499ae611","type":"text/javascript","exec":[""]}}],"_postman_id":"6336ff76-4e1f-4a65-90b2-014414d1a21c"},{"name":"Lessons","item":[{"name":"Retrieve a Lesson","id":"6dc0b822-d294-4145-be58-39cc6d42f3f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/lessons/:id","description":"Retrieve a single lesson response
\n","urlObject":{"path":["lessons",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"1fd8643f-eb0a-4575-acbc-5ee7f36b7033","name":"Retrieve a Lesson","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token token={{api_key}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/lessons/:id","host":["{{base_url}}"],"path":["lessons",":id"],"variable":[{"key":"id","value":"6385"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120114558"},{"key":"X-Request-Id","value":"13679d89d56b6c6d34f40485b7113e85"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.073963"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:45:57 GMT"},{"key":"Content-Length","value":"2064"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6385,\n \"name\": \"Math Tutoring\",\n \"description\": \"\",\n \"series_id\": 556,\n \"location_name\": \"Waterloo Location\",\n \"location_id\": 96,\n \"parent_location_name\": null,\n \"parent_location_id\": null,\n \"employee_name\": \"DeKorne, Angela\",\n \"employee_id\": 7099,\n \"service_name\": \"Math Tutoring\",\n \"service_id\": 89,\n \"spaces\": null,\n \"joinable\": null,\n \"from_date\": \"2020-01-31\",\n \"from_time\": \"12:00:00\",\n \"to_date\": \"2020-01-31\",\n \"to_time\": \"13:00:00\",\n \"time_zone\": \"Eastern Time (US & Canada)\",\n \"from_datetime\": \"2020-01-31T17:00:00Z\",\n \"to_datetime\": \"2020-01-31T18:00:00Z\",\n \"duration_minutes\": 60,\n \"status\": \"Scheduled\",\n \"custom_status\": null,\n \"wage\": \"15.0\",\n \"wage_payment_id\": null,\n \"cost_override\": null,\n \"override_method\": \"\",\n \"override_value\": null,\n \"request_comments\": null,\n \"requested_at\": null,\n \"request_customer_id\": null,\n \"request_student_id\": null,\n \"vehicle_id\": null,\n \"sms_sent_at\": null,\n \"reminder_sent_at\": null,\n \"cancelled_sent_at\": null,\n \"completed_at\": null,\n \"created_at\": \"2020-01-28T16:43:51Z\",\n \"updated_at\": \"2020-01-28T16:45:11Z\",\n \"participants\": [\n {\n \"id\": 12355,\n \"lesson_id\": 6385,\n \"student_name\": \"Vanderwier, Anna\",\n \"student_id\": 11386,\n \"description\": null,\n \"status\": \"Scheduled\",\n \"custom_status\": null,\n \"unit_price\": \"25.0\",\n \"cost_premium_included\": \"0.0\",\n \"discount_rate\": null,\n \"amount\": \"25.0\",\n \"cost_override_method\": null,\n \"public_notes\": null,\n \"private_notes\": null,\n \"invoice_id\": null,\n \"student_reminder_sent_at\": null,\n \"family_reminder_sent_at\": null,\n \"student_sms_sent_at\": null,\n \"family_sms_sent_at\": null,\n \"cancelled_sent_at\": null,\n \"notes_sent_at\": null,\n \"completed_at\": null,\n \"created_at\": \"2020-01-28T16:43:51Z\",\n \"updated_at\": \"2020-01-28T16:43:51Z\"\n },\n {\n \"id\": 12356,\n \"lesson_id\": 6385,\n \"student_name\": \"Elkman, Michael\",\n \"student_id\": 11388,\n \"description\": null,\n \"status\": \"Scheduled\",\n \"custom_status\": null,\n \"unit_price\": \"25.0\",\n \"cost_premium_included\": \"0.0\",\n \"discount_rate\": null,\n \"amount\": \"25.0\",\n \"cost_override_method\": null,\n \"public_notes\": null,\n \"private_notes\": null,\n \"invoice_id\": null,\n \"student_reminder_sent_at\": null,\n \"family_reminder_sent_at\": null,\n \"student_sms_sent_at\": null,\n \"family_sms_sent_at\": null,\n \"cancelled_sent_at\": null,\n \"notes_sent_at\": null,\n \"completed_at\": null,\n \"created_at\": \"2020-01-28T16:43:51Z\",\n \"updated_at\": \"2020-01-28T16:43:51Z\"\n }\n ]\n}"}],"_postman_id":"6dc0b822-d294-4145-be58-39cc6d42f3f3"},{"name":"List all Lessons","id":"15f6a642-1e6f-47f8-aa6e-b43a8e2e8636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/lessons","description":"Returns a list of lessons matching the search parameters
\n| Parameter | Description |
|---|---|
name | search by name |
series_id | search by series id for repeating lessons |
location_id | search by location id |
location_or_parent_location_id | search by location or parent location id (ie. if lesson location is a sub-location, this will match on the sub-location or parent location) |
employee_id | search by teacher id |
service_id | search by service id |
student_id | search by student id |
status | search by status |
custom_status | search by custom status |
from_date | search by date the lesson starts on. Use YYYY-MM-DD format. |
from_date[gt] | search where start date is greater than |
from_date[lt] | search where start date is less than |
from_date[gte] | search where start date is equal to or greater than |
from_date[lte] | search where start date is equal to or less than |
to_date | search by date the lesson ends on. Use YYYY-MM-DD format. |
to_date[gt] | search where lesson end date is greater than |
to_date[lt] | search where lesson end date is less than |
to_date[gte] | search where lesson end date is equal to or greater than |
to_date[lte] | search where lesson end date is equal to or less than |
id | search lesson id |
id[gt] | search where id is greater than |
id[lt] | search where id is less than |
id[gte] | search where id is equal to or greater than |
id[lte] | search where id is equal to or less than |
joinable | set to true to only list lessons marked as joinable |
page | pass an optional page number for pagination, defaults to page 1 |
per_page | number of records to display per each page, defaults to 20, maximum 50 |
direction | direction to sort by primary id (asc, desc), defaults to asc |
include_deleted | set to true to include deleted lessons in the API response |
Create a single lesson.
\nArguments
\n| Argument | Description |
|---|---|
name | Lesson name |
description | Description |
employee_id | Teacher ID |
student_ids[] | Array of student IDs |
service_id | Service ID |
location_id | Location ID |
spaces | Number of student spaces |
from_date | Start date of the lesson in YYYY-MM-DD format. |
from_time | Start time of the lesson in HH:MM:SS format. |
to_date | End date of the lesson in YYYY-MM-DD format. |
to_time | End time of the lesson in HH:MM:SS format. |
override | Overide default cost calculation (Boolean) |
override_method | Method for cost calculation. Accepted values: \"Service List Cost\", \"Student Cost\", \"Custom Adjusted\", and \"Custom Unadjusted\". |
override_value | Custom override cost if using \"Custom Adjusted\" or \"Custom Unadjusted\" override method. |
Add a student to an existing lesson. \nNote: Students can only be added to lessons with a status of \"Scheduled\".
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| student_id | ID of student |
Complete a lesson -- set attendance status, enter lesson notes, etc.
\nNotes About Custom Statuses\n
The custom_status parameter is only valid if the account has the Custom Statuses Add-on enabled. \n
The custom_status parameter overrides the status parameter if both are present.
Arguments
\n| Argument | \nDescription | \n
|---|---|
| name | Lesson name |
| wage | Teacher wage |
| from_date | Start date of the lesson in YYYY-MM-DD format. |
| from_time | Start time of the lesson in HH:MM:SS format. |
| to_date | End date of the lesson in YYYY-MM-DD format. |
| to_time | End time of the lesson in HH:MM:SS format. |
| status | Status of lesson if no participants in lesson. Scheduled, Attended, Missed, or Cancelled. |
| custom_status | Custom status of lesson if no participants in lesson. Only valid if Custom Statuses Add-on enabled in account. |
| participants_attributes | Attributes related to each participant in a lesson |
| » id | ID of the participant record |
| » status | Participant status. Scheduled, Attended, Missed, or Cancelled. |
| » custom_status | Participant custom_status. Only valid if Custom Statuses Add-on enabled in account. |
| » amount | Amount charged for participant |
| » public_notes | Lesson notes shared with client or student. |
| » private_notes | Lesson notes visible only to teacher and administrators. |
Retrieve or list lessons
\n","_postman_id":"8b58bff8-524a-4751-b28e-7faa12ab99fc"},{"name":"Lesson Participants","item":[{"name":"Retrieve a Lesson Participant","id":"5977666d-fc31-4464-b642-ebbf7e6ea08e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/lesson_participants/:id","description":"Retrieve a single lesson participant
\n","urlObject":{"path":["lesson_participants",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"15f2b61f-bc2d-4d8f-ae34-3c829514e77a","name":"Retrieve a Lesson Participant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/lesson_participants/:id","host":["{{base_url}}"],"path":["lesson_participants",":id"],"variable":[{"key":"id","value":"12353"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120114756"},{"key":"X-Request-Id","value":"a6b3f225c1e862b2647fa816038a2a4e"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.075358"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:47:55 GMT"},{"key":"Content-Length","value":"571"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12353,\n \"lesson_id\": 6384,\n \"student_name\": \"Vanderwier, Anna\",\n \"student_id\": 11386,\n \"description\": null,\n \"status\": \"Scheduled\",\n \"custom_status\": null,\n \"unit_price\": \"25.0\",\n \"cost_premium_included\": \"0.0\",\n \"discount_rate\": null,\n \"amount\": \"25.0\",\n \"cost_override_method\": null,\n \"public_notes\": null,\n \"private_notes\": null,\n \"invoice_id\": null,\n \"student_reminder_sent_at\": null,\n \"family_reminder_sent_at\": null,\n \"student_sms_sent_at\": null,\n \"family_sms_sent_at\": null,\n \"cancelled_sent_at\": null,\n \"notes_sent_at\": null,\n \"completed_at\": null,\n \"created_at\": \"2020-01-28T16:43:51Z\",\n \"updated_at\": \"2020-01-28T16:43:51Z\"\n}"}],"_postman_id":"5977666d-fc31-4464-b642-ebbf7e6ea08e"},{"name":"List all Lesson Participants","id":"7280fc28-2511-4590-abbf-854c73e05d51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/lesson_participants","description":"Returns a list of lesson participants that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| status | \nsearch by lesson status | \n
| custom_status | \nsearch by lesson custom status | \n
| student_id | \nsearch by student id | \n
| lesson_id | \nsearch by lesson id | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing lesson participants. Lesson participants are students that are enrolled in a lesson.
\n","_postman_id":"2c84aa31-cc18-4462-ad8b-d2dc56bd185d"},{"name":"Other Events","item":[{"name":"Retrieve an Other Event","id":"29f2f751-f2bf-4e1a-97ee-49595e6dabae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/other_events/:id","description":"Retrieve a single other event
\n","urlObject":{"path":["other_events",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"c3233f2f-1694-4ee4-8d47-ad9e354e69cd","name":"Retrieve an Other Event","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/other_events/:id","host":["{{base_url}}"],"path":["other_events",":id"],"variable":[{"key":"id","value":"862"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120115000"},{"key":"X-Request-Id","value":"27424af330988483ca8106b4c0388c1a"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.058149"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:49:59 GMT"},{"key":"Content-Length","value":"528"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 862,\n \"name\": \"Winter Open House\",\n \"description\": \"Join us for information and food at our Winter Open House.\",\n \"audience\": \"Everyone\",\n \"series_id\": null,\n \"job_id\": null,\n \"location_id\": 96,\n \"from_date\": \"2020-01-30\",\n \"from_time\": \"17:00:00\",\n \"to_date\": \"2020-01-30\",\n \"to_time\": \"20:00:00\",\n \"time_zone\": \"Eastern Time (US & Canada)\",\n \"from_datetime\": \"2020-01-30T22:00:00Z\",\n \"to_datetime\": \"2020-01-31T01:00:00Z\",\n \"duration_minutes\": 180,\n \"is_all_day\": false,\n \"created_at\": \"2020-01-28T16:49:27Z\",\n \"updated_at\": \"2020-01-28T16:49:27Z\",\n \"participants\": []\n}"}],"_postman_id":"29f2f751-f2bf-4e1a-97ee-49595e6dabae"},{"name":"List all Other Events","id":"47f7b2a9-55a0-426f-8be2-79a8480fc270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/other_events","description":"Returns a list of other events that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| series_id | \nsearch by series id for repeating events | \n
| location_id | \nsearch by location id | \n
| employee_id | \nsearch by employee id | \n
| from_date | \nsearch by date the event starts on. Use YYYY-MM-DD format.\n |
| from_date[gt] | search where date is greater than |
| from_date[lt] | search where date is less than |
| from_date[gte] | search where date is equal to or greater than |
| from_date[lte] | search where date is equal to or less than |
| to_date | \nsearch by date the event ends on. Use YYYY-MM-DD format. | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing other events. Other events can be general events or events that track an employee's non-teaching hours.
\n","_postman_id":"518d7e7f-8b49-4610-8835-34c6c0ef2a00"},{"name":"Availabilities","item":[{"name":"Retrieve an Availability","id":"967b496d-5219-4bea-b4ea-8e76d9fd5f7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/availabilities/:id","description":"Retrieve a single availability
\n","urlObject":{"path":["availabilities",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"43fe991d-a2af-43fe-9bad-ddb6bfc68be7","name":"Retrieve an Availability","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/availabilities/:id","host":["{{base_url}}"],"path":["availabilities",":id"],"variable":[{"key":"id","value":"22"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120115210"},{"key":"X-Request-Id","value":"0d80a1b64010ce18b010d0347760c018"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.077401"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:52:09 GMT"},{"key":"Content-Length","value":"173"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 22,\n \"employee_id\": 7099,\n \"day\": \"1\",\n \"start_time\": \"17:00:00\",\n \"end_time\": \"22:00:00\",\n \"description\": \"\",\n \"created_at\": \"2020-01-28T16:51:32Z\",\n \"updated_at\": \"2020-01-28T16:51:32Z\"\n}"}],"_postman_id":"967b496d-5219-4bea-b4ea-8e76d9fd5f7c"},{"name":"List all Availabilities","id":"78a704b1-8a2c-4d4f-a1d0-ff7832ae333d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/availabilities","description":"Returns a list of availabilities that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| employee_id | \nsearch by employee id | \n
| day | \nsearch by day of week (Sunday = 0) | \n
| start time | \nsearch by start time (HH:MM:SS) | \n
| end_time | \nsearch by end time (HH:MM:SS) | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing availabilities. Availabilities are the days of the week and times that teachers are available.
\n","_postman_id":"a6a92173-fd97-4783-90ff-f51b8bbede1a"},{"name":"Unavailabilities","item":[{"name":"Retrieve an Unavailability","id":"f0441e9c-8b9b-4002-9a9a-94e7a72adb07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/unavailabilities/:id","description":"Retrieve a single unavailability
\n","urlObject":{"path":["unavailabilities",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"b846338d-67af-4506-a6ac-17c16b5da81b","name":"Retrieve an Unavailability","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/unavailabilities/:id","host":["{{base_url}}"],"path":["unavailabilities",":id"],"variable":[{"key":"id","value":"2492"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120115354"},{"key":"X-Request-Id","value":"3e7fc231a82f6aae4a65e859dec8289b"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.071922"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:53:53 GMT"},{"key":"Content-Length","value":"358"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2492,\n \"series_id\": null,\n \"employee_id\": 7099,\n \"description\": \"Vacation\",\n \"from_date\": \"2020-02-03\",\n \"from_time\": \"00:00:00\",\n \"to_date\": \"2020-02-08\",\n \"to_time\": \"00:00:00\",\n \"time_zone\": \"Eastern Time (US & Canada)\",\n \"from_datetime\": \"2020-02-03T05:00:00Z\",\n \"to_datetime\": \"2020-02-08T05:00:00Z\",\n \"created_at\": \"2020-01-28T16:53:17Z\",\n \"updated_at\": \"2020-01-28T16:53:17Z\"\n}"}],"_postman_id":"f0441e9c-8b9b-4002-9a9a-94e7a72adb07"},{"name":"List all Unavailabilities","id":"b48255a6-58e4-4976-b80d-8866d0235070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/unavailabilities","description":"Returns a list of unavailabilities that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| employee_id | \nsearch by employee id | \n
| series_id | \nsearch by series id for repeating lessons | \n
| from_date | \nsearch by date the unavailability starts on. Use YYYY-MM-DD format.\n |
| from_date[gt] | search where start date is greater than |
| from_date[lt] | search where start date is less than |
| from_date[gte] | search where start date is equal to or greater than |
| from_date[lte] | search where start date is equal to or less than |
| to_date | \nsearch by date the unavailability ends on. Use YYYY-MM-DD format. | \n
| to_date[gt] | search where end date is greater than |
| to_date[lt] | search where end date is less than |
| to_date[gte] | search where end date is equal to or greater than |
| to_date[lte] | search where end date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing unavailabilities. Unavailabilties are specific dates and times that an employee is unavailable.
\n","_postman_id":"1503426e-ec00-42f3-821b-4cf475602b3d"},{"name":"Invoices","item":[{"name":"Retrieve an Invoice","id":"cf9d8052-59b7-4b13-906a-932e892ae175","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/invoices/:id","description":"Retrieve a single invoice
\n","urlObject":{"path":["invoices",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"0917d7c1-f1c2-4762-bdd0-ef1ed4b86b26","name":"Retrieve an Invoice","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/invoices/:id","host":["{{base_url}}"],"path":["invoices",":id"],"variable":[{"key":"id","value":"548"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120115648"},{"key":"X-Request-Id","value":"52d162979866fe9ae89b759d92db982a"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.067505"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:56:47 GMT"},{"key":"Content-Length","value":"1175"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 548,\n \"customer_id\": 13652,\n \"customer_first_name\": \"Frank & Tina\",\n \"customer_last_name\": \"Vanderwier\",\n \"invoice_type\": \"invoice\",\n \"number\": 2,\n \"date\": \"2020-01-28\",\n \"due_date\": \"2020-01-28\",\n \"reference\": \"\",\n \"tax_treatment\": \"Tax Exclusive\",\n \"status\": \"Approved\",\n \"start_date\": \"2020-01-26\",\n \"end_date\": \"2020-02-01\",\n \"lesson_status\": \"All\",\n \"terms_text\": null,\n \"subtotal\": \"50.0\",\n \"sales_tax_total\": \"0.0\",\n \"total\": \"50.0\",\n \"hide_flags\": false,\n \"sent_at\": null,\n \"reminder_sent_at\": null,\n \"created_at\": \"2020-01-28T16:56:01Z\",\n \"updated_at\": \"2020-01-28T16:56:01Z\",\n \"lessons\": [\n {\n \"id\": 12353,\n \"student_id\": 11386,\n \"employee_id\": 11,\n \"service_id\": 12,\n \"description\": \"Math Tutoring - Scheduled\\r\\n2020-01-29 12:00 PM - 01:00 PM\",\n \"status\": \"Scheduled\",\n \"custom_status\": null,\n \"invoice_unit_price\": \"25.0\",\n \"invoice_discount_rate\": null,\n \"invoice_amount\": \"25.0\",\n \"created_at\": \"2020-01-28T16:43:51Z\",\n \"updated_at\": \"2020-01-28T16:56:01Z\"\n },\n {\n \"id\": 12355,\n \"student_id\": 11386,\n \"service_id\": 12,\n \"description\": \"Math Tutoring - Scheduled\\r\\n2020-01-31 12:00 PM - 01:00 PM\",\n \"status\": \"Scheduled\",\n \"custom_status\": null,\n \"invoice_unit_price\": \"25.0\",\n \"invoice_discount_rate\": null,\n \"invoice_amount\": \"25.0\",\n \"created_at\": \"2020-01-28T16:43:51Z\",\n \"updated_at\": \"2020-01-28T16:56:01Z\"\n }\n ],\n \"charges\": [],\n \"packages\": []\n}"}],"_postman_id":"cf9d8052-59b7-4b13-906a-932e892ae175"},{"name":"List all Invoices","id":"5ecadc7b-4c2e-4600-a03a-a04b469428f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/invoices","description":"Returns a list of invoices that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| customer_id | \nsearch by customer id | \n
| number | \nsearch by invoice number | \n
| status | \nsearch by status (Saved, Approved, Paid, Void)\n |
| date | \nsearch by invoice date. Use YYYY-MM-DD format.\n |
| date[gt] | search where date is greater than |
| date[lt] | search where date is less than |
| date[gte] | search where date is equal to or greater than |
| date[lte] | search where date is equal to or less than |
| due_date | \nsearch by due date | \n
| due_date[gt] | search where date is greater than |
| due_date[lt] | search where date is less than |
| due_date[gte] | search where date is equal to or greater than |
| due_date[lte] | search where date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing customer invoices and credit notes
\n","_postman_id":"2c8a38b9-0dd1-4f77-9951-de3fd68dfe65"},{"name":"Payments","item":[{"name":"Retrieve a Payment","id":"f8f1a281-a274-42dd-8e59-5c89c8b3d316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/payments/:id","description":"Retrieve a single payment
\n","urlObject":{"path":["payments",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"9942dbad-ff9d-42a8-a7eb-f1b8822786a1","name":"Retrieve a Payment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/payments/:id","host":["{{base_url}}"],"path":["payments",":id"],"variable":[{"key":"id","value":"456"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120115908"},{"key":"X-Request-Id","value":"74643c8dd5fc13c5091202947a2f47be"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.070836"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 16:59:07 GMT"},{"key":"Content-Length","value":"497"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 456,\n \"customer_id\": 13654,\n \"customer_first_name\": \"Brandon & Janine\",\n \"customer_last_name\": \"Elkman\",\n \"date\": \"2020-01-29\",\n \"description\": \"INV-0001\",\n \"amount\": \"50.0\",\n \"type\": \"payment\",\n \"payment_method\": \"Cash\",\n \"stripe_transaction_id\": null,\n \"sent_at\": null,\n \"created_at\": \"2020-01-28T16:58:03Z\",\n \"updated_at\": \"2020-01-28T16:58:03Z\",\n \"refunds\": [],\n \"payment_allocations\": [\n {\n \"id\": 340,\n \"date\": \"2020-01-28\",\n \"amount\": \"50.0\",\n \"invoice_id\": 547,\n \"created_at\": \"2020-01-28T16:58:03Z\",\n \"updated_at\": \"2020-01-28T16:58:03Z\"\n }\n ]\n}"}],"_postman_id":"f8f1a281-a274-42dd-8e59-5c89c8b3d316"},{"name":"List all Payments","id":"d667e339-9352-4826-9b27-2263296968bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/payments","description":"Returns a list of payments that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| customer_id | \nsearch by customer id | \n
| date | \nsearch by payment date. Use YYYY-MM-DD format.\n |
| date[gt] | search where date is greater than |
| date[lt] | search where date is less than |
| date[gte] | search where date is equal to or greater than |
| date[lte] | search where date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create a payment.
\n\nArguments
\n| Argument | Description |
|---|---|
customer_id | ID of customer that made the payment |
date | Date |
amount | Amount |
description | Details or description of payment |
payment_method | Method of payment. Valid options are Cash, Check, Credit Card, Debit Card, Bank Transfer, PayPal, Other |
stripe_transaction_id | Transaction ID if processed through Stripe |
Use this endpoint to update a payment.
\nArguments
\n| Argument | \nDescription | \n
|---|---|
| customer_id | ID of customer that made the payment |
| date | Date |
| amount | Amount |
| description | Details or description of payment |
| payment_method | Method of payment. Valid options are Cash, Check, Credit Card, Debit Card, Bank Transfer, PayPal, Other |
| stripe_transaction_id | Transaction ID if processed through Stripe |
Endpoint for viewing customer payments and refunds
\n","_postman_id":"0d36520f-93c1-4e2e-9ecb-c5870e0377e1"},{"name":"Payment Allocations","item":[{"name":"Retrieve a Payment Allocation","id":"b9f6daa9-e2a7-4ddf-99ba-bba99bb34e93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/payment_allocations/:id","description":"Retrieve a single payment allocation
\n","urlObject":{"path":["payment_allocations",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"18c9abe9-ba99-4d8f-850f-fc47ddb57fc1","name":"Retrieve a Payment Allocation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base_url}}/payment_allocations/339"},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"130720104624"},{"key":"X-Request-Id","value":"6feea3dcbe01a5b163687a895b5fbbfc"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.030893"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Mon, 13 Jul 2020 14:46:23 GMT"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 339,\n \"date\": \"2020-01-28\",\n \"amount\": \"50.0\",\n \"payment_id\": 455,\n \"invoice_id\": 548,\n \"created_at\": \"2020-01-28T16:57:37Z\",\n \"updated_at\": \"2020-01-28T16:57:37Z\"\n}"}],"_postman_id":"b9f6daa9-e2a7-4ddf-99ba-bba99bb34e93"},{"name":"List all Payment Allocations","id":"5e1c1092-c3b6-42a9-9f22-21e7af936eb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/payment_allocations","description":"Returns a list of payments that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| payment_id | \nsearch by payment id | \n
| invoice_id | \nsearch by invoice id | \n
| date | \nsearch by payment date. Use YYYY-MM-DD format.\n |
| date[gt] | search where date is greater than |
| date[lt] | search where date is less than |
| date[gte] | search where date is equal to or greater than |
| date[lte] | search where date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create a payment allocation.
\n\nArguments
\n| Argument | \nDescription | \n
|---|---|
| payment_id | ID of payment that is being allocated |
| invoice_id | ID of invoice that payment is being allocated to |
| date | Date |
| amount | Amount being allocated |
Endpoint for allocating payments to invoices.
\n","event":[{"listen":"prerequest","script":{"id":"3fb2f93d-4376-450e-929b-580315302202","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ff71275-adc8-4f66-a8a9-4a24d6464e9d","type":"text/javascript","exec":[""]}}],"_postman_id":"51dbe75b-f89d-4e46-90f5-5b125032659c"},{"name":"Credit Note Allocations","item":[{"name":"Retrieve a Credit Note Allocation","id":"db94274f-1364-4642-b978-7bf9453addde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/credit_note_allocations/:id","description":"Retrieve a single credit note allocation
\n","urlObject":{"path":["credit_note_allocations",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"0b51f07c-7adf-489a-b1ef-9d3a6a0a9165","name":"Retrieve a Credit Note Allocation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base_url}}/credit_note_allocations/339"},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"130720104624"},{"key":"X-Request-Id","value":"6feea3dcbe01a5b163687a895b5fbbfc"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.030893"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Mon, 13 Jul 2020 14:46:23 GMT"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 339,\n \"date\": \"2020-01-28\",\n \"amount\": \"50.0\",\n \"credit_note_id\": 455,\n \"invoice_id\": 548,\n \"created_at\": \"2020-01-28T16:57:37Z\",\n \"updated_at\": \"2020-01-28T16:57:37Z\"\n}"}],"_postman_id":"db94274f-1364-4642-b978-7bf9453addde"},{"name":"List all Credit Note Allocations","id":"f18fc6fb-b56d-49fe-8415-2bf00b79255c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/credit_note_allocations","description":"Returns a list of payments that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| credit_note_id | \nsearch by credit note id | \n
| invoice_id | \nsearch by invoice id | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for credit note allocations to invoices.
\n","event":[{"listen":"prerequest","script":{"id":"8c9f40c2-448b-4741-bd69-2272383a7958","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"86a0efa4-2852-4483-a21f-ce2f8d6a00bd","type":"text/javascript","exec":[""]}}],"_postman_id":"8952ee51-342e-44b8-97c0-54115c5b3540"},{"name":"Other Compensation","item":[{"name":"Retrieve Compensation","id":"f8c5642a-aa36-4405-af0b-b5901e2816d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/other_compensation/:id","description":"Retrieve a single compensation record
\n","urlObject":{"path":["other_compensation",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"d5beb102-8a8d-4e8f-8bc7-31e6dd5b6002","type":"string","value":"","key":"id"}]}},"response":[{"id":"c5749265-0d6a-493a-940a-4894725ae996","name":"Retrieve Compensation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/other_compensation/:id","host":["{{base_url}}"],"path":["other_compensation",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 30 Mar 2020 13:09:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Status","value":"200 OK"},{"key":"Cache-Control","value":"must-revalidate, no-cache, no-store, private, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"x-RateLimit-Limit","value":"1"},{"key":"x-RateLimit-Remaining","value":"0"},{"key":"x-RateLimit-Reset","value":"300320130912"},{"key":"X-Request-Id","value":"4e70a6d87507bacca9337e39c892670e"},{"key":"X-UA-Compatible","value":"IE=Edge,chrome=1"},{"key":"X-Runtime","value":"0.023574"},{"key":"X-Rack-Cache","value":"miss"},{"key":"Vary","value":"Origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 20278,\n \"employee_id\": 851,\n \"employee_first_name\": \"Sandra\",\n \"employee_last_name\": \"Ackman\",\n \"date\": \"2020-03-17\",\n \"description\": \"Reimbursement for supplies\",\n \"amount\": \"100.0\",\n \"wage_payment_id\": null,\n \"created_at\": \"2020-03-18T00:02:14.000Z\",\n \"updated_at\": \"2020-03-18T00:02:14.000Z\"\n }"}],"_postman_id":"f8c5642a-aa36-4405-af0b-b5901e2816d6"},{"name":"List all Compensation","id":"6188cfef-e723-4c4e-ba6f-962e9c565c8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/other_compensation","description":"Returns a list of wage payments that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| employee_id | \nsearch by employee id | \n
| date | \nsearch by compensation date. Use YYYY-MM-DD format.\n |
| date[gt] | search where date is greater than |
| date[lt] | search where date is less than |
| date[gte] | search where date is equal to or greater than |
| date[lte] | search where date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create other compensation. All fields are required.
\n\nArguments
\n| Argument | \nDescription | \n
|---|---|
| employee_id | ID of employee the payment is for |
| date | Date |
| amount | Amount |
| description | Details or description of payment |
Endpoint for viewing non-hourly compensation for employees
\n","_postman_id":"81630c22-7f64-4a2b-9800-ac71831ee0ba"},{"name":"Wage Payments","item":[{"name":"Retrieve a Wage Payment","id":"faf2848f-6d40-4483-8d33-9acb093382ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/wage_payments/:id","description":"Retrieve a single wage payment
\n","urlObject":{"path":["wage_payments",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"5184e448-f84f-4a1a-8ab9-13657b18906a","name":"Retrieve a Wage Payment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/wage_payments/:id","host":["{{base_url}}"],"path":["wage_payments",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 30 Mar 2020 13:09:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Status","value":"200 OK"},{"key":"Cache-Control","value":"must-revalidate, no-cache, no-store, private, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"x-RateLimit-Limit","value":"1"},{"key":"x-RateLimit-Remaining","value":"0"},{"key":"x-RateLimit-Reset","value":"300320130912"},{"key":"X-Request-Id","value":"4e70a6d87507bacca9337e39c892670e"},{"key":"X-UA-Compatible","value":"IE=Edge,chrome=1"},{"key":"X-Runtime","value":"0.023574"},{"key":"X-Rack-Cache","value":"miss"},{"key":"Vary","value":"Origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 187422,\n \"employee_id\": 851,\n \"employee_first_name\": \"Sandra\",\n \"employee_last_name\": \"Ackman\",\n \"date\": \"2020-03-01\",\n \"description\": \"\",\n \"amount\": \"90.0\",\n \"sent_at\": null,\n \"created_at\": \"2020-03-01T15:29:24Z\",\n \"updated_at\": \"2020-03-01T15:29:24Z\"\n}"}],"_postman_id":"faf2848f-6d40-4483-8d33-9acb093382ba"},{"name":"List all Wage Payments","id":"dc1e6997-93e0-45e4-9c02-f7e64c19e77e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/wage_payments","description":"Returns a list of wage payments that match the search parameters
\n| Parameter | \nDescription | \n
|---|---|
| employee_id | \nsearch by employee id | \n
| date | \nsearch by wage payment date. Use YYYY-MM-DD format.\n |
| date[gt] | search where date is greater than |
| date[lt] | search where date is less than |
| date[gte] | search where date is equal to or greater than |
| date[lte] | search where date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create a wage payment.
\n\nArguments
\n| Argument | \nDescription | \n
|---|---|
| employee_id | ID of employee the payment is for |
| date | Date |
| amount | Amount |
| description | Details or description of payment |
Use this endpoint to update a wage payment.
\n\nArguments
\n| Argument | \nDescription | \n
|---|---|
| employee_id | ID of employee the payment is for |
| date | Date |
| amount | Amount |
| description | Details or description of payment |
Endpoint for viewing teacher and staff payments
\n","_postman_id":"d5992de6-234b-49dc-81f7-690d1806c520"},{"name":"Result Groups","item":[{"name":"Retrieve a Result Group","id":"ebe18030-ce2f-4920-9103-61a971d7f738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/result_groups/:id","description":"Retrieve a single result group by id
\n","urlObject":{"path":["result_groups",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"bcc46cc8-a56d-4d7a-a193-0f2f2c665588","name":"Retrieve a Result Group","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/result_groups/:id","host":["{{base_url}}"],"path":["result_groups",":id"],"variable":[{"key":"id","value":"89"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120105453"},{"key":"X-Request-Id","value":"f12374ad4e9cb246457b49b6df505d14"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.049591"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 15:54:52 GMT"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 78,\n \"name\": \"Math Tests\",\n \"sections\": \"\",\n \"created_at\": \"2024-07-16T14:56:32.000Z\",\n \"updated_at\": \"2024-07-16T14:56:32.000Z\"\n}"}],"_postman_id":"ebe18030-ce2f-4920-9103-61a971d7f738"},{"name":"List all Result Groups","id":"16a94766-4326-449f-8b01-cd011825013c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/result_groups","description":"Get a list of all result groups matching your search parameters
\n| Parameter | \nDescription | \n
|---|---|
| name | \nsearch by name | \n
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Endpoint for viewing result groups from the Result Tracking add-on.
\n","event":[{"listen":"prerequest","script":{"id":"ca35ed30-7b36-481a-9276-8c213555c267","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc27203d-4f3b-4f9c-9bb8-5a920c708320","type":"text/javascript","exec":[""]}}],"_postman_id":"0b9e49d8-ba24-4066-a513-b155c459d0bb"},{"name":"Results","item":[{"name":"Retrieve a Result","id":"01d7813a-27a0-4688-8bff-165cfa2620df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/results/:id","description":"Retrieve a single result by id
\n","urlObject":{"path":["results",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[{"id":"b30ab752-d16f-4d3b-88dd-62773e14518e","name":"Retrieve a Result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/results/:id","host":["{{base_url}}"],"path":["results",":id"],"variable":[{"key":"id","value":"89"}]}},"status":"OK ","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Fri, 01 Jan 1990 00:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-Ratelimit-Limit","value":"1"},{"key":"X-Ratelimit-Remaining","value":"0"},{"key":"X-Ratelimit-Reset","value":"280120105453"},{"key":"X-Request-Id","value":"f12374ad4e9cb246457b49b6df505d14"},{"key":"X-Ua-Compatible","value":"IE=Edge"},{"key":"X-Runtime","value":"0.049591"},{"key":"Vary","value":"Origin"},{"key":"Server","value":"WEBrick/1.3.1 (Ruby/2.0.0/2015-12-16)"},{"key":"Date","value":"Tue, 28 Jan 2020 15:54:52 GMT"},{"key":"Content-Length","value":"164"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 179,\n \"result_group_id\": 79,\n \"result_group_name\": \"Math Tests\",\n \"result_group_sections\": \"\",\n \"student_id\": 288,\n \"student_name\": \"Kristin Anderson\",\n \"date\": \"2024-07-25\",\n \"value\": \"92\",\n \"created_at\": \"2024-07-16T14:57:04.000Z\",\n \"updated_at\": \"2024-07-16T14:57:04.000Z\"\n}"}],"_postman_id":"01d7813a-27a0-4688-8bff-165cfa2620df"},{"name":"List all Results","id":"29c46d7f-eb9a-4a7d-9a7b-e6fa6bafa661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/results","description":"Get a list of all results matching your search parameters
\n| Parameter | \nDescription | \n
|---|---|
| student_id | \nsearch by student id | \n
| result_group_id | \nsearch by result group id | \n
| date | \nsearch by result date. Use YYYY-MM-DD format.\n |
| date[gt] | search where date is greater than |
| date[lt] | search where date is less than |
| date[gte] | search where date is equal to or greater than |
| date[lte] | search where date is equal to or less than |
| page | \npass an optional page number for pagination, defaults to page 1 | \n
| per_page | \nnumber of records to display per each page, defaults to 20, maximum 50 | \n
| direction | \ndirection to sort by primary id (asc, desc), defaults to asc | \n
Use this endpoint to create a result.
\n\nArguments
\n| Argument | Description |
|---|---|
result_group_id | ID of result group the result belongs to |
student_id | ID of student the result belongs to |
date | Date |
value | Result value. Note: If the result group has sections, separate each result with a comma. |
Use this endpoint to update a result.
\nArguments
\n| Argument | Description |
|---|---|
result_group_id | ID of result group the result belongs to |
student_id | ID of student the result belongs to |
date | Date |
value | Result value. Note: If the result group has sections, separate each result with a comma. |
Endpoint for viewing results from the Result Tracking add-on.
\n","event":[{"listen":"prerequest","script":{"id":"ca35ed30-7b36-481a-9276-8c213555c267","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc27203d-4f3b-4f9c-9bb8-5a920c708320","type":"text/javascript","exec":[""]}}],"_postman_id":"9ecfb024-ebd1-47f6-b37b-b2548262e9b6"},{"name":"Repertoires","item":[{"name":"List all Repertoires","id":"eba12f89-5ef0-4453-854a-36b5787f6075","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"}],"url":"{{base_url}}/repertoires","description":"Get a list of all Repertoires
\n","urlObject":{"path":["repertoires"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c4322b15-7400-4cbc-8888-d91ee3393f11","name":"List all Repertoires","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base_url}}/repertoires"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 14,\n \"student_id\": 12142,\n \"student_name\": \"Nedd Stark\",\n \"title\": \"Java Programming\",\n \"composer\": \"Jon Snow\",\n \"duration\": \"5:45\",\n \"genre\": \"Computer Science\",\n \"difficulty\": \"Medium\",\n \"status\": \"In Progress\",\n \"date_started\": \"2024-10-07\",\n \"date_completed\": \"\",\n \"source\": \"Java for Beginners\",\n \"notes\": \"\",\n \"deleted_at\": null,\n \"created_at\": \"2024-10-07T13:46:46.000Z\",\n \"updated_at\": \"2024-10-07T13:46:46.000Z\",\n \"performances\": [\n {\n \"id\": 13,\n \"event\": \"Java Beginners - 101\",\n \"date\": \"2024-10-07\",\n \"grade\": \"A\",\n \"comments\": \"Well documented presentation\"\n }\n ]\n }\n]"}],"_postman_id":"eba12f89-5ef0-4453-854a-36b5787f6075"},{"name":"Retrieve a Repertoire","id":"32ea77f6-8ea5-4efb-aa66-ee7044a1a6d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"}],"url":"{{base_url}}/repertoires/:id","urlObject":{"path":["repertoires",":id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"14","key":"id"}]}},"response":[{"id":"e21d4674-4311-4051-af1c-a083dd56ab54","name":"Retrieve a Repertoire","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{base_url}}/repertoires/14"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 14,\n \"student_id\": 12142,\n \"student_name\": \"Nedd Stark\",\n \"title\": \"Java Programming\",\n \"composer\": \"Jon Snow\",\n \"duration\": \"5:45\",\n \"genre\": \"Computer Science\",\n \"difficulty\": \"Medium\",\n \"status\": \"In Progress\",\n \"date_started\": \"2024-10-07\",\n \"date_completed\": \"\",\n \"source\": \"Java for Beginners\",\n \"notes\": \"\",\n \"deleted_at\": null,\n \"created_at\": \"2024-10-07T13:46:46.000Z\",\n \"updated_at\": \"2024-10-07T13:46:46.000Z\",\n \"performances\": [\n {\n \"id\": 13,\n \"event\": \"Java Beginners - 101\",\n \"date\": \"2024-10-07\",\n \"grade\": \"A\",\n \"comments\": \"Well documented presentation\"\n }\n ]\n }\n]"}],"_postman_id":"32ea77f6-8ea5-4efb-aa66-ee7044a1a6d2"},{"name":"Create a Repertoire","id":"3f80dd4b-fe63-497d-9c15-74000e229077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"repertoire\" : {\n \"student_id\": 1356219,\n \"title\": \"Test From API\",\n \"composer\": \"Composer Test\",\n \"duration_minutes\": 5,\n \"duration_seconds\": 30,\n \"genre\": \"Project Report\",\n \"difficulty\": \"Medium\",\n \"status\": \"In Progress\",\n \"date_started\": \"2024-10-06\",\n \"date_completed\": \"2024-10-30\",\n \"notes\": \"Some Test Notes\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/repertoires","description":"Attributes
\n","urlObject":{"path":["repertoires"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5080dfee-a694-4ff1-b625-3408fb288fff","name":"Create a Repertoire","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token token={{api_key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"repertoire\": {\n \"student_id\": 12143,\n \"title\": \"Test From API\",\n \"composer\": \"Composer Test\",\n \"duration_minutes\": 5,\n \"duration_seconds\": 30,\n \"genre\": \"Project Report\",\n \"difficulty\": \"Medium\",\n \"status\": \"In Progress\",\n \"date_started\": \"2024-10-06\",\n \"date_completed\": \"2024-10-30\",\n \"notes\": \"Some Test Notes\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/repertoires"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 15,\n \"student_id\": 12143,\n \"student_name\": \"Brandon Stark\",\n \"title\": \"Test From API\",\n \"composer\": \"Composer Test\",\n \"duration\": \"5:30\",\n \"genre\": \"Project Report\",\n \"difficulty\": \"Medium\",\n \"status\": \"In Progress\",\n \"date_started\": \"2024-10-06\",\n \"date_completed\": \"2024-10-30\",\n \"source\": \"\",\n \"notes\": \"Some Test Notes\",\n \"deleted_at\": null,\n \"created_at\": \"2024-10-07T14:45:25.000Z\",\n \"updated_at\": \"2024-10-07T14:45:25.000Z\",\n \"performances\": []\n}"}],"_postman_id":"3f80dd4b-fe63-497d-9c15-74000e229077"}],"id":"136cbeed-06b8-402e-a9f8-9c3d476c21ed","_postman_id":"136cbeed-06b8-402e-a9f8-9c3d476c21ed","description":""}],"event":[{"listen":"prerequest","script":{"id":"4e847435-3987-402f-afb0-6c5b74fc5b8c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e738375-4b9d-4fc8-a38d-aa03873b1e52","type":"text/javascript","exec":[""]}}]}