{"info":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","description":"

Getting Started

The first thing you need is an API key. If you do not have one, contact your portal admin to get a key.

Every request will need the API key passed in the headers, with a key of \"x-api-key\" and the value as your API key.

The request URLs will be in the form of https://www.YourPortalURL.com/wp-json/xy/v2/{route}.

HTTP Status Code Summary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
200 - OK	Everything worked as expected
400 - Bad Request	The request was not accepted, often due to missing a required parameter
403 - Forbidden	The API does not have permission to request that resource
404 - Not Found	The requested resource does not exist
500 - Server Error	Something went wrong on our end

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"HTTP Status Code Summary","slug":"http-status-code-summary"}],"owner":"7448493","collectionId":"266b6657-5ccd-4944-8b5b-8f60e5516e45","publishedId":"TVzVgvQK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"353535","highlight":"f9b546"},"publishDate":"2021-01-19T23:09:20.000Z"},"item":[{"name":"Users","item":[{"name":"Create a User","id":"2a8e2d13-3010-4355-a6db-621e3d32e24a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"user1234","type":"text","description":"

Username for the user

\n","contentType":""},{"key":"email","value":"email@example.com","type":"text","description":"

Email address of the user

\n","contentType":""},{"key":"first_name","value":"John","type":"text","description":"

User's first name

\n","disabled":true},{"key":"last_name","value":"Smith","type":"text","description":"

User's last name

\n","disabled":true},{"key":"employee_id","value":"1234567890","type":"text","description":"

Employee ID of the user (not the same as the user's unique ID; commonly the same as username)

\n","disabled":true},{"key":"hiring_date","value":"2000-01-01","type":"text","description":"

User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"is_active","value":"true","type":"text","description":"

Status of the user

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users","description":"

Creates a new user, returns the saved user object with formatted data

Arguments

Object Key	Data Type	Max Length	Required?	Description
username	string	60	Yes	Username of the user, must be unique
email	string	100	Yes	Email address of the user, must be unique
display_name	string	100	No	Display name of the user, usually first + last name
first_name	string	100	No	First name
last_name	string	100	No	Last name
roles	string		No	Comma separated list of user roles, any of: \"employee\" \"xy_client_user\" \"xy_client_leader\" \"xy_client_supervisor\" \"xy_client_admin\" Note: \"employee\" and \"xy_client_user\" will always be included, even if not explicitly set
employee_id	string	11	No	Employee ID of the user (not the same as the user's unique ID; commonly the same as username)
job_title_id	integer	11	No	ID of the user's job title
department_id	integer	11	No	ID of the department the user belongs to
location_id	integer	11	No	ID of the company location the user is at
managers	integer(s)		No	Comma separated list of user IDs to assign as managers
mentors	integer(s)		No	Comma separated list of user IDs to assign as mentors
hiring_date	string	10	No	User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)
termination_date	string	10	No	User's termination date, in the format of \"yyyy-mm-dd\" (UTC)
pay_rate	integer	20	No	User's pay rate
pay_type	string	20	No	The pay cycle for a user, one of: \"hourly\" \"daily\" \"weekly\" \"monthly\" \"yearly\" \"contract\"
employment_type	string	20	No	Type of employee, one of: \"permanent\" (full time) \"parttime\" \"call_in\" \"contract\" \"intern\" \"manager\" \"seasonal\" \"special\" \"temporary\" \"trainee\"
employment_status	integer	20	No	Status of employee, one of: \"active\" \"deceased\" \"layoff\" \"leave_of_absence\" \"military_leave\" \"retired\" \"terminated\"
is_active	boolean	1	No	Status of the user - 0 or 1 (any non-zero value resolves to true)
is_management	boolean	1	No	Flag if the user is management - 0 or 1 (any non-zero value resolves to true)
date_of_birth	string	10	No	User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)
ssn_last	string	4	No	Last four digits of the user's SSN
external_identifier	string	50	No	UUID for 3rd party identification

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","users"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[{"id":"24e6bac4-5d12-43e4-8fd0-31da35a10caf","name":"Example #1","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"user1234","type":"text","description":"Username for the user"},{"key":"email","value":"email@example.com","type":"text","description":"Email address of the user"},{"key":"first_name","value":"John","type":"text","description":"User's first name"},{"key":"last_name","value":"Smith","type":"text","description":"User's last name"},{"key":"roles","value":"xy_client_user","type":"text","description":"Comma separated list of user roles, any of:\n\"employee\", \n\"xy_client_user\", \n\"xy_client_leader\", \n\"xy_client_supervisor\", \n\"xy_client_admin\". \nNote: \"employee\" and \"xy_client_user\" will always be included, even if not explicitly set","disabled":true},{"key":"employee_id","value":"1234567890","type":"text","description":"Employee ID of the user (not the same as the user's unique ID; commonly the same as username)"},{"key":"job_title_id","value":"","type":"text","description":"ID of the user's job title","disabled":true},{"key":"department_id","value":"","type":"text","description":"ID of the department the user belongs to","disabled":true},{"key":"location_id","value":"","type":"text","description":"ID of the company location the user is at","disabled":true},{"key":"managers","value":"","description":"Comma separated list of user IDs to assign as managers","type":"text","disabled":true},{"key":"mentors","value":"","description":"Comma separated list of user IDs to assign as mentors","type":"text","disabled":true},{"key":"hiring_date","value":"2000-01-01","type":"text","description":"User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)","disabled":true},{"key":"termination_date","value":"","type":"text","description":"User's termination date, in the format of \"yyyy-mm-dd\" (UTC)","disabled":true},{"key":"pay_rate","value":"12345","type":"text","description":"User's pay rate","disabled":true},{"key":"pay_type","value":"yearly","type":"text","description":"The pay cycle for a user, one of:\n\"hourly\"\n\"daily\"\n\"weekly\"\n\"monthly\"\n\"yearly\"\n\"contract\"","disabled":true},{"key":"employment_type","value":"permanent","type":"text","description":"Type of employee, one of: \"permanent\" (full time), \"parttime\", \"call_in\", \"contract\", \"intern\", \"manager\", \"seasonal\", \"special\", \"temporary\", \"trainee\"","disabled":true},{"key":"employment_status","value":"active","type":"text","description":"Status of employee, one of: \"active\", \"deceased\", \"layoff\", \"leave_of_absence\", \"military_leave\", \"retired\", \"terminated\"","disabled":true},{"key":"is_active","value":"true","type":"text","description":"Status of the user","disabled":true},{"key":"is_management","value":"true","type":"text","description":"Flag if the user is management","disabled":true},{"key":"date_of_birth","value":"1960-02-03","type":"text","description":"User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)","disabled":true},{"key":"ssn_last","value":"1234","type":"text","description":"Last four digits of the user's SSN","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"UUID for 3rd party identification","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Jan 2021 20:53:15 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-WP-DoingItWrong","value":"register_rest_route (since 5.5.0; The REST API route definition for toolset/v2/search-posts is missing the required permission_callback argument. For REST API routes that are intended to be public, use __return_true as the permission callback.)"},{"key":"X-Robots-Tag","value":"noindex"},{"key":"Link","value":"; rel=\"https://api.w.org/\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Expose-Headers","value":"X-WP-Total, X-WP-TotalPages, Link"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-WP-Nonce, Content-Disposition, Content-MD5, Content-Type"},{"key":"Allow","value":"GET, POST"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Edge-Location-Klb","value":"KyPk0KoJXpgIH03kqd7i25QD87ee3be7b9e527046f18eb0ee2e54ba5"}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": 978,\n \"username\": \"user1234\",\n \"email\": \"email@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"description\": \"\",\n \"roles\": [\n \"xy_client_user\",\n \"employee\"\n ],\n \"employee_id\": \"1234567890\",\n \"job_title_id\": 0,\n \"department_id\": 0,\n \"location_id\": 0,\n \"job_role_id\": 0,\n \"job_role_level_id\": 0,\n \"hiring_date\": \"\",\n \"termination_date\": \"\",\n \"pay_rate\": \"\",\n \"pay_type\": \"\",\n \"employment_type\": \"\",\n \"employment_status\": \"\",\n \"is_active\": true,\n \"is_management\": false,\n \"date_of_birth\": \"\",\n \"ssn_last\": \"0000\",\n \"external_identifier\": null,\n \"job_title\": {\n \"id\": 0,\n \"name\": \"\",\n \"external_identifier\": \"\"\n },\n \"department\": {\n \"id\": 0,\n \"name\": \"\",\n \"external_identifier\": \"\"\n },\n \"location\": {\n \"id\": 0,\n \"name\": \"\",\n \"external_identifier\": \"\"\n },\n \"courses\": [],\n \"expired_courses\": [],\n \"completed_courses\": [],\n \"past_due_courses\": [],\n \"manager_ids\": \"\",\n \"managers\": [],\n \"mentors\": [],\n \"groups\": []\n}"},{"id":"85f9f5a4-3c99-465f-acd0-5414be5ddcb7","name":"Example #2","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"8675309","type":"text","description":"Username for the user","contentType":""},{"key":"email","value":"elon@spacex.com","type":"text","description":"Email address of the user","contentType":""},{"key":"first_name","value":"Elon","type":"text","description":"User's first name"},{"key":"last_name","value":"Musk","type":"text","description":"User's last name"},{"key":"roles","value":"employee, xy_client_user","type":"text","description":"Comma separated list of user roles, any of:\n\"employee\", \n\"xy_client_user\", \n\"xy_client_leader\", \n\"xy_client_supervisor\", \n\"xy_client_admin\". \nNote: \"employee\" and \"xy_client_user\" will always be included, even if not explicitly set"},{"key":"employee_id","value":"emusk","type":"text","description":"Employee ID of the user (not the same as the user's unique ID; commonly the same as username)"},{"key":"job_title_id","value":"12","type":"text","description":"ID of the user's job title"},{"key":"department_id","value":"17","type":"text","description":"ID of the department the user belongs to"},{"key":"location_id","value":"46","type":"text","description":"ID of the company location the user is at"},{"key":"managers","value":"","description":"Comma separated list of user IDs to assign as managers","type":"text","disabled":true},{"key":"mentors","value":"","description":"Comma separated list of user IDs to assign as mentors","type":"text","disabled":true},{"key":"hiring_date","value":"2002-05-06","type":"text","description":"User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)"},{"key":"termination_date","value":"2020-01-28","type":"text","description":"User's termination date, in the format of \"yyyy-mm-dd\" (UTC)"},{"key":"pay_rate","value":"101,958","type":"text","description":"User's pay rate"},{"key":"pay_type","value":"yearly","type":"text","description":"The pay cycle for a user, one of:\n\"hourly\"\n\"daily\"\n\"weekly\"\n\"monthly\"\n\"yearly\"\n\"contract\""},{"key":"employment_type","value":"permanent","type":"text","description":"Type of employee, one of: \"permanent\" (full time), \"parttime\", \"call_in\", \"contract\", \"intern\", \"manager\", \"seasonal\", \"special\", \"temporary\", \"trainee\""},{"key":"employment_status","value":"active","type":"text","description":"Status of employee, one of: \"active\", \"deceased\", \"layoff\", \"leave_of_absence\", \"military_leave\", \"retired\", \"terminated\""},{"key":"is_active","value":"true","type":"text","description":"Status of the user"},{"key":"is_management","value":"true","type":"text","description":"Flag if the user is management"},{"key":"date_of_birth","value":"1971-06-28","type":"text","description":"User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)"},{"key":"ssn_last","value":"5432","type":"text","description":"Last four digits of the user's SSN"},{"key":"external_identifier","value":"emp-4815162342","type":"text","description":"UUID for 3rd party identification"}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 19 Jan 2021 13:46:51 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-WP-DoingItWrong","value":"register_rest_route (since 5.5.0; The REST API route definition for toolset/v2/search-posts is missing the required permission_callback argument. For REST API routes that are intended to be public, use __return_true as the permission callback.)"},{"key":"X-Robots-Tag","value":"noindex"},{"key":"Link","value":"; rel=\"https://api.w.org/\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Expose-Headers","value":"X-WP-Total, X-WP-TotalPages, Link"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-WP-Nonce, Content-Disposition, Content-MD5, Content-Type"},{"key":"Allow","value":"GET, POST"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Edge-Location-Klb","value":"KyPk0KoJXpgIH03kqd7i25QD942c9cf61387e7a21dfe7369d6dd6ca5"}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": 981,\n \"username\": \"8675309\",\n \"email\": \"elon@spacex.com\",\n \"display_name\": \"\",\n \"first_name\": \"Elon\",\n \"last_name\": \"Musk\",\n \"description\": \"\",\n \"roles\": [\n \"xy_client_user\",\n \"employee\"\n ],\n \"employee_id\": \"emusk\",\n \"job_title_id\": \"12\",\n \"department_id\": \"17\",\n \"location_id\": \"46\",\n \"job_role_id\": 0,\n \"job_role_level_id\": 0,\n \"hiring_date\": \"2002-05-06\",\n \"termination_date\": \"2020-01-28\",\n \"pay_rate\": \"101,958\",\n \"pay_type\": \"yearly\",\n \"employment_type\": \"permanent\",\n \"employment_status\": \"active\",\n \"is_active\": true,\n \"is_management\": true,\n \"date_of_birth\": \"1971-06-28\",\n \"ssn_last\": \"5432\",\n \"external_identifier\": \"emp-4815162342\",\n \"job_title\": {\n \"id\": \"12\",\n \"name\": \"Mars Traveler\",\n \"external_identifier\": \"6277\"\n },\n \"department\": {\n \"id\": \"17\",\n \"name\": \"Space Exploration\",\n \"external_identifier\": \"spx\"\n },\n \"location\": {\n \"id\": \"46\",\n \"name\": \"SpaceX\",\n \"external_identifier\": \"abcd-1234\"\n },\n \"courses\": [],\n \"expired_courses\": [],\n \"completed_courses\": [],\n \"past_due_courses\": [],\n \"manager_ids\": \"\",\n \"managers\": [],\n \"mentors\": [],\n \"groups\": []\n}"},{"id":"cc98dadc-6245-4f31-b0c2-57185c706781","name":"Example #3","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"jbezos","type":"text","description":"Username for the user","contentType":""},{"key":"email","value":"jbezos@spacex.com","type":"text","description":"Email address of the user","contentType":""},{"key":"first_name","value":"Jeff","type":"text","description":"User's first name"},{"key":"last_name","value":"Bezos","type":"text","description":"User's last name"},{"key":"roles","value":"xy_client_user, employee, xy_client_leader, xy_client_supervisor","type":"text","description":"Comma separated list of user roles, any of:\n\"employee\", \n\"xy_client_user\", \n\"xy_client_leader\", \n\"xy_client_supervisor\", \n\"xy_client_admin\". \nNote: \"employee\" and \"xy_client_user\" will always be included, even if not explicitly set"},{"key":"employee_id","value":"9998765432","type":"text","description":"Employee ID of the user (not the same as the user's unique ID; commonly the same as username)"},{"key":"job_title_id","value":"12","type":"text","description":"ID of the user's job title"},{"key":"department_id","value":"17","type":"text","description":"ID of the department the user belongs to"},{"key":"location_id","value":"46","type":"text","description":"ID of the company location the user is at"},{"key":"managers","value":"981","description":"Comma separated list of user IDs to assign as managers","type":"text","disabled":true},{"key":"mentors","value":"981","description":"Comma separated list of user IDs to assign as mentors","type":"text","disabled":true},{"key":"hiring_date","value":"2021-01-11","type":"text","description":"User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)"},{"key":"termination_date","value":"2021-01-15","type":"text","description":"User's termination date, in the format of \"yyyy-mm-dd\" (UTC)","disabled":true},{"key":"pay_rate","value":"10.00","type":"text","description":"User's pay rate"},{"key":"pay_type","value":"hourly","type":"text","description":"The pay cycle for a user, one of:\n\"hourly\"\n\"daily\"\n\"weekly\"\n\"monthly\"\n\"yearly\"\n\"contract\""},{"key":"employment_type","value":"intern","type":"text","description":"Type of employee, one of: \"permanent\" (full time), \"parttime\", \"call_in\", \"contract\", \"intern\", \"manager\", \"seasonal\", \"special\", \"temporary\", \"trainee\""},{"key":"employment_status","value":"leave_of_absence","type":"text","description":"Status of employee, one of: \"active\", \"deceased\", \"layoff\", \"leave_of_absence\", \"military_leave\", \"retired\", \"terminated\""},{"key":"is_active","value":"true","type":"text","description":"Status of the user"},{"key":"is_management","value":"false","type":"text","description":"Flag if the user is management"},{"key":"date_of_birth","value":"1970-12-25","type":"text","description":"User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)"},{"key":"ssn_last","value":"5544","type":"text","description":"Last four digits of the user's SSN"},{"key":"external_identifier","value":"jbezos","type":"text","description":"UUID for 3rd party identification"},{"key":"job_role_id","value":"42","type":"text"},{"key":"job_role_level_id","value":"43","type":"text"}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 19 Jan 2021 14:37:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"X-WP-DoingItWrong","value":"register_rest_route (since 5.5.0; The REST API route definition for toolset/v2/search-posts is missing the required permission_callback argument. For REST API routes that are intended to be public, use __return_true as the permission callback.)"},{"key":"X-Robots-Tag","value":"noindex"},{"key":"Link","value":"; rel=\"https://api.w.org/\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Expose-Headers","value":"X-WP-Total, X-WP-TotalPages, Link"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-WP-Nonce, Content-Disposition, Content-MD5, Content-Type"},{"key":"Allow","value":"GET, POST"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Edge-Location-Klb","value":"KyPk0KoJXpgIH03kqd7i25QDee2bf3a173cf09e45d42f686ac5e299c"}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": 985,\n \"username\": \"jbezos\",\n \"email\": \"jbezos@spacex.com\",\n \"display_name\": \"\",\n \"first_name\": \"Jeff\",\n \"last_name\": \"Bezos\",\n \"description\": \"\",\n \"roles\": [\n \"xy_client_user\",\n \"xy_client_leader\",\n \"xy_client_supervisor\",\n \"employee\"\n ],\n \"employee_id\": \"9998765432\",\n \"job_title_id\": \"12\",\n \"department_id\": \"17\",\n \"location_id\": \"46\",\n \"job_role_id\": \"42\",\n \"job_role_level_id\": \"43\",\n \"hiring_date\": \"2021-01-11\",\n \"termination_date\": \"\",\n \"pay_rate\": \"10.00\",\n \"pay_type\": \"hourly\",\n \"employment_type\": \"intern\",\n \"employment_status\": \"leave_of_absence\",\n \"is_active\": true,\n \"is_management\": false,\n \"date_of_birth\": \"1970-12-25\",\n \"ssn_last\": \"5544\",\n \"external_identifier\": \"jbezos\",\n \"job_title\": {\n \"id\": \"12\",\n \"name\": \"Mars Traveler\",\n \"external_identifier\": \"6277\"\n },\n \"department\": {\n \"id\": \"17\",\n \"name\": \"Space Exploration\",\n \"external_identifier\": \"spx\"\n },\n \"location\": {\n \"id\": \"46\",\n \"name\": \"SpaceX\",\n \"external_identifier\": \"abcd-1234\"\n },\n \"courses\": [],\n \"expired_courses\": [],\n \"completed_courses\": [],\n \"past_due_courses\": [],\n \"manager_ids\": \"\",\n \"managers\": [],\n \"mentors\": [],\n \"groups\": []\n}"}],"_postman_id":"2a8e2d13-3010-4355-a6db-621e3d32e24a"},{"name":"List All Users","id":"73075842-81d0-4124-8961-47fedf8f4d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users","description":"

Returns an array of user objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","users"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"73075842-81d0-4124-8961-47fedf8f4d93"},{"name":"Retrieve User","id":"e1ae8a8a-04e6-4f6c-98c1-6536bc8a6ca7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/1","description":"

Get a single user object, referenced by the user ID or username

Usage

\n
/users/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","users","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1ae8a8a-04e6-4f6c-98c1-6536bc8a6ca7"},{"name":"Retrieve User by External ID","id":"f33648a6-a12c-40d8-8815-055702bc7112","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/abcd-1234/external","description":"

Single user object, referenced by the external_identifier

Usage

\n
/users/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","users","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f33648a6-a12c-40d8-8815-055702bc7112"},{"name":"Update User","id":"45b6f6ca-4809-4d70-8fb6-698f84315d59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"user1234","type":"text","description":"

Username of the user, must be unique

\n","disabled":true},{"key":"email","value":"email123@example.com","type":"text","description":"

Email address of the user, must be unique

\n","disabled":true},{"key":"first_name","value":"Jane","type":"text","description":"

First name

\n","disabled":true},{"key":"last_name","value":"Doe","type":"text","description":"

Last name

\n","disabled":true},{"key":"employee_id","value":"0987654321","type":"text","description":"

Employee ID of the user (not the same as the user's unique ID; commonly the same as username)

\n","disabled":true},{"key":"hiring_date","value":"2000-01-01","type":"text","description":"

User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"is_active","value":"true","type":"text","description":"

Status of the user - 0 or 1 (any non-zero value resolves to true)

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/1","description":"

Updates an existing user, referenced by the user ID or username\nReturns the updated user object with formatted data

Usage

\n
/users/{id}
\n

Arguments

Object Key	Data Type	Max Length	Required?	Description
email	string	60	No, unless passing \"email\" in the request, then it cannot be empty	Email address of the user
display_name	string	100	No	Display name of the user, usually first + last name
first_name	string	100	No	First name
last_name	string	100	No	Last name
roles	string		No	Comma separated list of user roles, any of: \"employee\" \"xy_client_user\" \"xy_client_leader\" \"xy_client_supervisor\" \"xy_client_admin\" Note: \"employee\" and \"xy_client_user\" will always be included, even if not explicitly set
employee_id	string	11	No	Employee ID of the user (not the same as the user's unique ID; commonly the same as username)
job_title_id	integer	11	No	ID of the user's job title
department_id	integer	11	No	ID of the department the user belongs to
location_id	integer	11	No	ID of the company location the user is at
managers	integer(s)		No	Comma separated list of user IDs to assign as managers. Managers can be removed by leaving them off the list. An empty value will remove all managers. If no changes are required, either pass the existing IDs or do not pass \"managers\" in the request.
mentors	integer(s)		No	Comma separated list of user IDs to assign as mentors. Mentors can be removed by leaving them off the list. An empty value will remove all mentors. If no changes are required, either pass the existing IDs or do not pass \"mentors\" in the request.
hiring_date	string	10	No	User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)
termination_date	string	10	No	User's termination date, in the format of \"yyyy-mm-dd\" (UTC)
pay_rate	integer	20	No	User's pay rate
pay_type	string	20	No	The pay cycle for a user, one of: \"hourly\" \"daily\" \"weekly\" \"monthly\" \"yearly\" \"contract\"
employment_type	string	20	No	Type of employee, one of: \"permanent\" (full time) \"parttime\" \"call_in\" \"contract\" \"intern\" \"manager\" \"seasonal\" \"special\" \"temporary\" \"trainee\"
employment_status	integer	20	No	Status of employee, one of: \"active\" \"deceased\" \"layoff\" \"leave_of_absence\" \"military_leave\" \"retired\" \"terminated\"
is_active	boolean	1	No	Status of the user - 0 or 1 (any non-zero value resolves to true)
is_management	boolean	1	No	Flag if the user is management - 0 or 1 (any non-zero value resolves to true)
date_of_birth	string	10	No	User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)
ssn_last	string	4	No	Last four digits of the user's SSN
external_identifier	string	50	No	UUID for 3rd party identification

Username of the user, must be unique

\n","disabled":true},{"key":"email","value":"email123@example.com","type":"text","description":"

Email address of the user, must be unique

\n","disabled":true},{"key":"display_name","value":"Jane Doe","type":"text","description":"

Display name of the user, usually first + last name

\n","disabled":true},{"key":"first_name","value":"Jane","type":"text","description":"

First name

\n","disabled":true},{"key":"last_name","value":"Doe","type":"text","description":"

Last name

\n","disabled":true},{"key":"employee_id","value":"0987654321","type":"text","description":"

Employee ID of the user (not the same as the user's unique ID; commonly the same as username)

\n","disabled":true},{"key":"hiring_date","value":"2000-01-01","type":"text","description":"

User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"is_active","value":"true","type":"text","description":"

Status of the user - 0 or 1 (any non-zero value resolves to true)

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/abcd-1234/external","description":"

Update a user, referenced by their external_identifier

Updates an existing user, referenced by the user ID or username\nReturns the updated user object with formatted data

Usage

\n
/users/{id}/external
\n

Arguments

Object Key	Data Type	Max Length	Required?	Description
email	string	60	No, unless passing \"email\" in the request, then it cannot be empty	Email address of the user
display_name	string	100	No	Display name of the user, usually first + last name
first_name	string	100	No	First name
last_name	string	100	No	Last name
roles	string		No	Comma separated list of user roles, any of: \"employee\" \"xy_client_user\" \"xy_client_leader\" \"xy_client_supervisor\" \"xy_client_admin\" Note: \"employee\" and \"xy_client_user\" will always be included, even if not explicitly set
employee_id	string	11	No	Employee ID of the user (not the same as the user's unique ID; commonly the same as username)
job_title_id	integer	11	No	ID of the user's job title
department_id	integer	11	No	ID of the department the user belongs to
location_id	integer	11	No	ID of the company location the user is at
managers	integer(s)		No	Comma separated list of user IDs to assign as managers. Managers can be removed by leaving them off the list. An empty value will remove all managers. If no changes are required, either pass the existing IDs or do not pass \"managers\" in the request.
mentors	integer(s)		No	Comma separated list of user IDs to assign as mentors. Mentors can be removed by leaving them off the list. An empty value will remove all mentors. If no changes are required, either pass the existing IDs or do not pass \"mentors\" in the request.
hiring_date	string	10	No	User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)
termination_date	string	10	No	User's termination date, in the format of \"yyyy-mm-dd\" (UTC)
pay_rate	integer	20	No	User's pay rate
pay_type	string	20	No	The pay cycle for a user, one of: \"hourly\" \"daily\" \"weekly\" \"monthly\" \"yearly\" \"contract\"
employment_type	string	20	No	Type of employee, one of: \"permanent\" (full time) \"parttime\" \"call_in\" \"contract\" \"intern\" \"manager\" \"seasonal\" \"special\" \"temporary\" \"trainee\"
employment_status	integer	20	No	Status of employee, one of: \"active\" \"deceased\" \"layoff\" \"leave_of_absence\" \"military_leave\" \"retired\" \"terminated\"
is_active	boolean	1	No	Status of the user - 0 or 1 (any non-zero value resolves to true)
is_management	boolean	1	No	Flag if the user is management - 0 or 1 (any non-zero value resolves to true)
date_of_birth	string	10	No	User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)
ssn_last	string	4	No	Last four digits of the user's SSN
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned user object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
user_id	integer	Unique ID of the user
username	string	Username for the user
email	string	Email address of the user
display_name	string	User's display name (usually first + last name)
first_name	string	User's first name
last_name	string	User's last name
roles	array	List of user roles
employee_id	string	User's employee ID
job_title	object	Data for the user's job title
job_title.id	integer	Unique ID for the user's job title
job_title.name	string	Name of the user's job title
job_title.external_identifier	string	UUID of the job title for 3rd party identification
department	object	Data for the user's department
department.id	integer	Unique ID for the department
department.name	string	Name of the department
department.external_identifier	string	UUID of the department for 3rd party identification
location	object	Data for the user's location
location.id	integer	Unique ID for the user's location
location.name	string	Name of the user's location
location.external_identifier	string	UUID of the location for 3rd party identification
managers	array	User data for each manager
manager.id (for each manager)	integer	Name of the manager
manager.name (for each manager)	string	Name of the user's location
manager.external_identifier	string	UUID of the manager for 3rd party identification
mentors	aray	User data for each mentor
mentor.id (for each mentor)	integer	User ID of the mentor
mentor.name (for each mentor)	string	Name of the mentor
hiring_date	string	User's hiring date, in the format of \"yyyy-mm-dd\" (UTC)
termination_date	string	User's termination date, in the format of \"yyyy-mm-dd\" (UTC)
pay_rate	string	User's pay rate
pay_type	string	The pay cycle for a user, one of: \"hourly\" \"daily\" \"weekly\" \"monthly\" \"yearly\" \"contract\"
employment_type	string	Type of employee, one of: \"permanent\" (full time) \"parttime\" \"call_in\" \"contract\" \"intern\" \"manager\" \"seasonal\" \"special\" \"temporary\" \"trainee\"
employment_status	string	Status of employee, one of: \"active\" \"deceased\" \"layoff\" \"leave_of_absence\" \"military_leave\" \"retired\" \"terminated\"
is_active	boolean	Status of the user
is_management	boolean	Flag if the user is management
date_of_birth	string	User's date of birth, in the format of \"yyyy-mm-dd\" (UTC)
external_identifier	string	UUID for 3rd party identification
courses	array	Course data for each course the user is enrolled in
course.id (for each course)	integer	Unique ID of the course
course.name (for each course)	string	Name of the course
course.completed (for each course)	integer	1 if course is completed, 0 if not
course.external_identifier (for each course)	string	UUID of the course for 3rd party identification
expired_courses	array	Course data for each expired course for the user
expired_course.id (for each course)	integer	Unique ID of the course
expired_course.name (for each course)	string	Name of the course
expired_course.completed (for each course)	integer	1 if course is completed, 0 if not
expired_course.external_identifier (for each course)	string	UUID of the course for 3rd party identification
completed_courses	array	Course data for each course the user has completed
completed_course.id (for each course)	integer	Unique ID of the course
completed_course.name (for each course)	string	Name of the course
completed_course.completed (for each course)	integer	1 if course is completed, 0 if not
completed_course.external_identifier (for each course)	string	UUID of the course for 3rd party identification
past_due_courses	array	Course data for each past due course for the user
past_due_course.name (for each course)	string	Name of the course
past_due_course.completed (for each course)	integer	1 if course is completed, 0 if not
past_due_course.external_identifier (for each course)	string	UUID of the course for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"cae2f723-bdf5-4313-9fd3-5205adfd13bf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6a7ae6b6-1059-4e8c-8f42-491855c9ef83","type":"text/javascript","exec":[""]}}],"_postman_id":"a4005dd4-e1ec-4f3d-9a5a-2b04910c7453","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Courses","item":[{"name":"Create a Course","id":"eb9b5b9e-bb64-4d33-942a-315628bdec4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Course name

\n"},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/courses","description":"

Creates a new course, returns the saved course object with formatted data

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	Yes	Course name
external_identifier	string	50	No	UUID for 3rd party identification

Returns an array of department objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","courses"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6027cc86-8156-4fc3-a586-06a989bedd7d"},{"name":"Retrieve Course","id":"b1c44185-8fef-4cc7-b31f-702f60b86a9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/courses/1","description":"

Get a single course object, referenced by the course ID

Usage

\n
/courses/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","courses","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1c44185-8fef-4cc7-b31f-702f60b86a9a"},{"name":"Retrieve Course by External ID","id":"6bfede6d-e4c7-4e04-bdf6-3e72e746f9e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/courses/abcd-1234/external","description":"

Get a single course object, referenced by the external_identifier

Usage

\n
/courses/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","courses","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6bfede6d-e4c7-4e04-bdf6-3e72e746f9e3"},{"name":"Update Course","id":"bd0fc240-1b25-40d4-b8b9-7ff8d63c595a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Unique ID for the course

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/courses/1","description":"

Update a course, referenced by its id

Usage

\n
/courses/{id}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Course name
external_identifier	string	50	No	UUID for 3rd party identification

Course name

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/courses/abcd-1234/external","description":"

Update a course, referenced by its external_identifier

Usage

\n
/courses/{external_identifier}/external
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Course name
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned course object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
id	integer	Unique ID for the course
name	string	Course name
lessons	array	Lesson data for each lesson associated with the course
lesson.id (for each lesson)	integer	Unique ID for the lesson
lesson.name (for each lesson)	string	Name of the lesson
users	array	User data for each user enrolled in the course
user.id (for each user)	integer	Unique ID for the user
user.name (for each user)	string	Name of the user
user.completed (for each user)	integer	1 if course is completed, 0 if not
user.external_identifier (for each user)	string	UUID for 3rd party identification
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"f4f6fadc-6391-4d61-b33e-667b31f1f3f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0590a43e-2325-4142-95df-a50b308125aa","type":"text/javascript","exec":[""]}}],"_postman_id":"757e447b-9441-4921-99b8-11825c08873a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"User Courses","item":[{"name":"Retrieve User Course Data","id":"aa0000a9-f03f-4af4-a239-7e9ba54db394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/1234/course/1234","description":"

Get user's course data, referenced by the user ID/username and course ID

Usage

\n
/users/{userId}/course/{courseId}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","users","1234","course","1234"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa0000a9-f03f-4af4-a239-7e9ba54db394"},{"name":"Retrieve User Course Data by External ID","id":"bef5190b-998d-48c8-8df3-26ff41ccc72f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/abcd-1234/course/abcd-1234/external","description":"

Get a user's course data for a given course. The user and course are both referenced by their respective external_identifiers.

Usage

\n
/users/{userId}/course/{courseId}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","users","abcd-1234","course","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bef5190b-998d-48c8-8df3-26ff41ccc72f"},{"name":"Update User Course Data","id":"e2a00c09-96c7-4e6a-82eb-9374fc2a4797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"enrolled","type":"text","value":"1","description":"

Enrollment status of the user - 0 (disenrolled) or 1 (enrolled); any non-zero value resolves to true)

\n"},{"key":"expiration_date","type":"text","value":"2021-12-31","description":"

Date the course expires for the user, formatted as \"yyyy-mm-dd\" (UTC)

\n"},{"key":"due_date","type":"text","value":"2021-12-01","description":"

Date course completion is due for the user, formatted as \"yyyy-mm-dd\" (UTC)

\n"},{"key":"license_type","value":"full","description":"

License for the course, one of: \"full\", \"trial\", \"lifetime\"

\n","type":"text"}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/981/course/36324","description":"

Updates existing user data for a given course, referenced by the user id and course id

Usage

\n
/users/{userId}/course/{courseId}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
enrolled	boolean	1	No	Enrollment status of the user - 0 (disenrolled) or 1 (enrolled); any non-zero value resolves to true)
expiration_date	string	10	No	Date the course expires for the user, formatted as \"yyyy-mm-dd\" (UTC)
due_date	string	10	No	Date course completion is due for the user, formatted as \"yyyy-mm-dd\" (UTC)
license_type	string	8	No	License for the course, one of: \"full\" \"trial\" \"lifetime\"

Enrollment status of the user - 0 (disenrolled) or 1 (enrolled); any non-zero value resolves to true)

\n","disabled":true},{"key":"expiration_date","value":"","type":"text","description":"

Date the course expires for the user, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"due_date","value":"","type":"text","description":"

Date course completion is due for the user, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"license_type","value":"trial","description":"

License for the course, one of: \"full\", \"trial\", \"lifetime\"

\n","type":"text","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/users/abcd-1234/course/abcd-1234/external","description":"

Updates existing user data for a given course, referenced by the user external_identifier and course external_identifier

Usage

\n
/users/{externalUserId}/course/{externalCourseId}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
enrolled	boolean	1	No	Enrollment status of the user - 0 (disenrolled) or 1 (enrolled); any non-zero value resolves to true)
expiration_date	string	10	No	Date the course expires for the user, formatted as \"yyyy-mm-dd\" (UTC)
due_date	string	10	No	Date course completion is due for the user, formatted as \"yyyy-mm-dd\" (UTC)
license_type	string	8	No	License for the course, one of: \"full\" \"trial\" \"lifetime\"

Schema

The schema describes the format of returned course data objects.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
user	object	Data for the user
user.id	integer	Unique ID of the user
user.display_name	string	User's display name (usually first + last name)
course	object	Data for the course
course.id	integer	Unique ID of the course
course.name	string	Name of the course
enrolled	boolean	0 if user is not enrolled, 1 if user is enrolled
expiration_date	string	Date the course expires, formatted as \"yyyy-mm-dd\" (UTC)
due_date	string	Date the course is due, formatted as \"yyyy-mm-dd\" (UTC)
license_type	string	License for the course, one of: \"full\" \"trial\" \"lifetime\".
completed	boolean	0 if not completed, 1 if completed
progress	integer	Percentage of course completed
progress_message	string	Message noting whether the user has started, progressed, or completed the course
completed_date	string	Date of course completion, formatted as \"yyyy-mm-dd\" (UTC)
score	integer	Score/result for the course (after completion)

","event":[{"listen":"prerequest","script":{"id":"ea8c5427-6337-49eb-b12d-32aa3da426a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bba4a28d-7723-4538-a5bd-d9f73fdf3413","type":"text/javascript","exec":[""]}}],"_postman_id":"0e19199b-ffbd-4ffd-aad8-9d570ea886cb","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Locations","item":[{"name":"Create a Location","id":"c7dde594-85f4-4a37-a8fc-a7783bb05f6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"XY Learning","type":"text","description":"

Name of the location

\n"},{"key":"address_1","value":"721 Evergreen Terrace","type":"text","description":"

Address (field 1) of the location

\n","disabled":true},{"key":"city","value":"Grand Rapids","type":"text","description":"

Location's city

\n"},{"key":"state","value":"MI","type":"text","description":"

Location's state

\n"},{"key":"country","value":"US","description":"

Location's country

\n","type":"text","disabled":true},{"key":"postal_code","value":"12345","type":"text","description":"

Location's postal code

\n","disabled":true},{"key":"phone","value":"555-555-5555","type":"text","description":"

Location's phone number

\n","disabled":true},{"key":"leaders","value":"","description":"

Comma separated list of user IDs to assign as location leads

\n","type":"text","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/locations/","description":"

Creates a new location, returns the saved location object with formatted data

Arguments

Object Key	Data Type	Max Length	Required?	Description
name	string	200	Yes	Name of the location
description	string	200	No	Description of the location
address_1	string	200	No	Address (field 1) of the location
address_2	string	200	No	Address (field 2) of the location
city	string	100	No	Location's city
state	string	20	No	Location's state
postal_code	string	20	No	Location's postal code
country	string	50	No	Location's country
district	string	50	No	Location's district
county	string	50	No	Location's county
phone	string	16	No	Location's phone number
email	string	200	No	Primary email address for the location
logo_url	string	1024	No	URL for the location's logo
leaders	string		No	Comma separated list of user IDs to assign as location leads.
external_identifier	string	50	No	UUID for 3rd party identification

Returns an array of location objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","locations",""],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"df9d4635-a4f4-4365-81dd-8c80bbb7a0d7"},{"name":"Retrieve Location","id":"e3ebdfdc-ccc2-49b6-bd0c-b74eeaa71d6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/locations/1","description":"

Returns a single location object, referenced by the location ID

Usage

\n
/locations/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","locations","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3ebdfdc-ccc2-49b6-bd0c-b74eeaa71d6c"},{"name":"Retrieve Location by External ID","id":"a24e81ad-a33e-4854-9bee-e0cd70ccee3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/locations/abcd-1234/external","description":"

Returns a single location object, referenced by the external_identifier

Usage

\n
/locations/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","locations","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a24e81ad-a33e-4854-9bee-e0cd70ccee3f"},{"name":"Update Location","id":"b69814b5-4b59-4699-aef2-76193145ba9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Name of the location

\n","disabled":true},{"key":"address_1","value":"721 Evergreen Terrace","type":"text","description":"

Address (field 1) of the location

\n","disabled":true},{"key":"city","value":"Springfield","type":"text","description":"

Location's city

\n","disabled":true},{"key":"state","value":"AA","type":"text","description":"

Location's state

\n","disabled":true},{"key":"postal_code","value":"12345","type":"text","description":"

Location's postal code

\n","disabled":true},{"key":"country","value":"US","type":"text","description":"

Location's country

\n","disabled":true},{"key":"phone","value":"555-555-5555","type":"text","description":"

Location's phone number

\n","disabled":true},{"key":"leaders","value":"","description":"

Comma separated list of user IDs to assign as location leads. Location leads can be removed by leaving them off the list. An empty value will remove all location leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.

\n","type":"text","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/locations/1","description":"

Updates an existing location (referenced by the location ID), returns the updated location object with formatted data

Usage

\n
/locations/{id}
\n

Arguments

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Name of the location
description	string	200	No	Description of the location
address_1	string	200	No	Address (field 1) of the location
address_2	string	200	No	Address (field 2) of the location
city	string	100	No	Location's city
state	string	20	No	Location's state
postal_code	string	20	No	Location's postal code
country	string	50	No	Location's country
district	string	50	No	Location's district
county	string	50	No	Location's county
phone	string	16	No	Location's phone number
email	string	200	No	Primary email address for the location
logo_url	string	1024	No	URL for the location's logo
leaders	string		No	Comma separated list of user IDs to assign as location leads. Location leads can be removed by leaving them off the list. An empty value will remove all location leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
external_identifier	string	50	No	UUID for 3rd party identification

Name of the location

\n","disabled":true},{"key":"address_1","value":"721 Evergreen Terrace","type":"text","description":"

Address (field 1) of the location

\n","disabled":true},{"key":"city","value":"Springfield","type":"text","description":"

Location's city

\n","disabled":true},{"key":"state","value":"AA","type":"text","description":"

Location's state

\n","disabled":true},{"key":"postal_code","value":"12345","type":"text","description":"

Location's postal code

\n","disabled":true},{"key":"country","value":"US","type":"text","description":"

Location's country

\n","disabled":true},{"key":"phone","value":"555-555-5555","type":"text","description":"

Location's phone number

\n","disabled":true},{"key":"leaders","value":"","description":"

\n","type":"text","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/locations/1","description":"

Updates an existing location (referenced by the location ID), returns the updated location object with formatted data

Usage

\n
/locations/{id}
\n

Arguments

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Name of the location
description	string	200	No	Description of the location
address_1	string	200	No	Address (field 1) of the location
address_2	string	200	No	Address (field 2) of the location
city	string	100	No	Location's city
state	string	20	No	Location's state
postal_code	string	20	No	Location's postal code
country	string	50	No	Location's country
district	string	50	No	Location's district
county	string	50	No	Location's county
phone	string	16	No	Location's phone number
email	string	200	No	Primary email address for the location
logo_url	string	1024	No	URL for the location's logo
leaders	string		No	Comma separated list of user IDs to assign as location leads. Location leads can be removed by leaving them off the list. An empty value will remove all location leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
external_identifier	string	50	No	UUID for 3rd party identification

Name of the location

\n","disabled":true},{"key":"address_1","value":"721 Evergreen Terrace","type":"text","description":"

Address (field 1) of the location

\n","disabled":true},{"key":"city","value":"Springfield","type":"text","description":"

Location's city

\n","disabled":true},{"key":"state","value":"AA","type":"text","description":"

Location's state

\n","disabled":true},{"key":"postal_code","value":"12345","type":"text","description":"

Location's postal code

\n","disabled":true},{"key":"country","value":"US","type":"text","description":"

Location's country

\n","disabled":true},{"key":"phone","value":"555-555-5555","type":"text","description":"

Location's phone number

\n","disabled":true},{"key":"leaders","value":"","description":"

\n","type":"text","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/locations/abcd-1234/external","description":"

Updates an existing location (referenced by the external_identifier), returns the updated location object with formatted data

Usage

\n
/locations/{external_identifier}/external
\n

Arguments

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Name of the location
description	string	200	No	Description of the location
address_1	string	200	No	Address (field 1) of the location
address_2	string	200	No	Address (field 2) of the location
city	string	100	No	Location's city
state	string	20	No	Location's state
postal_code	string	20	No	Location's postal code
country	string	50	No	Location's country
district	string	50	No	Location's district
county	string	50	No	Location's county
phone	string	16	No	Location's phone number
email	string	200	No	Primary email address for the location
logo_url	string	1024	No	URL for the location's logo
leaders	string		No	Comma separated list of user IDs to assign as location leads. Location leads can be removed by leaving them off the list. An empty value will remove all location leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned location object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
id	integer	Unique ID for the location
name	string	Name of the location
description	string	Description of the location
address_1	string	Address (field 1) of the location
address_2	string	Address (field 2) of the location
city	string	Location's city
state	string	Location's state
postal_code	string	Location's postal code
country	string	Location's country
district	string	Location's district
county	string	Location's county
phone	string	Location's phone number
email	string	Primary email address for the location
logo_url	string	URL for the location's logo
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"a8158d45-382a-4994-ae9f-bbb5a9b4016e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"29adfc59-5600-47ae-940a-833c78c982fb","type":"text/javascript","exec":[""]}}],"_postman_id":"5e657e23-be55-449e-9e4d-418cb9a92e20","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Departments","item":[{"name":"Create a Department","id":"acbe9972-c175-434e-9ffd-78a6ec090d3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Department name

\n"},{"key":"parent_id","value":"0","type":"text","description":"

Parent department's ID

\n","disabled":true},{"key":"location_id","value":"0","type":"text","description":"

Department's location ID

\n","disabled":true},{"key":"leads","value":"","type":"text","description":"

Comma separated list of user IDs to assign as department leads

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/departments","description":"

Creates a new department, returns the saved department object with formatted data

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	Yes	Department name
description	string	65,535	No	Description of the department
parent_id	integer	11	No	Parent department's ID
location_id	integer	11	No	Department's location ID
is_active	boolean	1	No	0 or 1 (any non-zero value resolves to true)
leads	integer(s)		No	Comma separated list of user IDs to assign as department leads
external_identifier	string	50	No	UUID for 3rd party identification

Get all departments

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","departments"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7db6a3a6-6b5f-4ec0-8c31-7764cc2c65d7"},{"name":"Retrieve Department","id":"d20ce333-b5f0-4926-be7c-4725edc9104e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/departments/1","description":"

Get a single department object, referenced by the department ID

Usage

\n
/departments/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","departments","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d20ce333-b5f0-4926-be7c-4725edc9104e"},{"name":"Retrieve Department by External ID","id":"844f47d6-1c9a-46c0-8fb1-5b0ba7af9b3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/departments/abcd-1234/external","description":"

Get a single department object, referenced by the external_identifier

Usage

\n
/departments/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","departments","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"844f47d6-1c9a-46c0-8fb1-5b0ba7af9b3c"},{"name":"Update Department","id":"f6af2c8a-9537-4931-a022-078b61ec50f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing update","type":"text","description":"

Department name

\n","disabled":true},{"key":"parent_id","value":"0","type":"text","description":"

ID of the parent department (0 if the department has no parent)

\n","disabled":true},{"key":"location_id","value":"0","type":"text","description":"

ID of the department's location (0 if the department has no location)

\n","disabled":true},{"key":"leads","value":"114, 90","type":"text","description":"

User data for each department lead. An empty value will remove all department leads.

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/departments/1","description":"

Update a course, referenced by its id

Usage

\n
/departments/{id}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Department name
description	string	65,535	No	Description of the department
parent_id	integer	11	No	Parent department's ID
location_id	integer	11	No	Department's location ID
is_active	boolean	1	No	0 or 1 (any non-zero value resolves to true)
leads	integer(s)		No	Comma separated list of user IDs to assign as department leads. Department leads can be removed by leaving them off the list. An empty value will remove all department leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
external_identifier	string	50	No	UUID for 3rd party identification

Department name

\n","disabled":true},{"key":"parent_id","type":"text","value":"0","description":"

ID of the parent department (0 if the department has no parent)

\n","disabled":true},{"key":"location_id","type":"text","value":"0","description":"

ID of the department's location (0 if the department has no location)

\n","disabled":true},{"key":"leads","type":"text","value":"114, 90","description":"

User data for each department lead

\n","disabled":true},{"key":"external_identifier","type":"text","value":"abcd-1234","description":"

UUID for 3rd party identification. An empty value will remove all department leads.

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/departments/abcd-1234/external","description":"

Updates an existing department (referenced by the external_identifier), returns the updated department object with formatted data

Usage

\n
/departments/{external_identifier}/external
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Department name
description	string	65,535	No	Description of the department
parent_id	integer	11	No	Parent department's ID
location_id	integer	11	No	Department's location ID
is_active	boolean	1	No	0 or 1 (any non-zero value resolves to true)
leads	integer(s)		No	Comma separated list of user IDs to assign as department leads. Department leads can be removed by leaving them off the list. An empty value will remove all department leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned course object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
id	integer	Unique ID for the department
name	string	Department name
description	string	Department description
is_active	boolean	Department's status
leads	array	User data for each department lead
lead.id (for each lead)	integer	User ID of the department lead
lead.name (for each lead)	string	Name of the department lead
parent	object	Data for a parent department
parent.id	integer	ID of the parent department (0 if the department has no parent)
parent.name	string	Title of the parent department
location	object	Data for the department's location
location.id	integer	ID of the department's location (0 if the department has no location)
location.name	string	Name of the department's location
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"a104b7e8-3688-4f4e-9f60-63efde963742","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4af3163c-bc33-4d69-92a1-712c4a165342","type":"text/javascript","exec":[""]}}],"_postman_id":"83a40d2d-7077-4b89-b992-09facc768081","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Job Titles","item":[{"name":"Create a Job Title","id":"19aa4284-d6ab-4f35-8b30-0f3b29d6f3a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Job title

\n"},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/jobtitles","description":"

Creates a new job title, returns the saved job title object with formatted data

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	Yes	Job title
external_identifier	string	50	No	UUID for 3rd party identification

Returns an array of job title objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","jobtitles"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1583c195-86b3-4214-a598-bc53f198c8dd"},{"name":"Retrieve Job Title","id":"3f98a8f4-fd83-4b1f-8689-67909553ff70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/jobtitles/1","description":"

Get a single job title object, referenced by the job title ID

Usage

\n
/jobtitles/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","jobtitles","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f98a8f4-fd83-4b1f-8689-67909553ff70"},{"name":"Retrieve Job Title by External ID","id":"cf0fd32a-17d4-4926-b4a7-6f0467999b7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/jobtitles/abcd-1234/external","description":"

Get a single job title object, referenced by the external_identifier

Usage

\n
/jobtitles/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","jobtitles","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf0fd32a-17d4-4926-b4a7-6f0467999b7f"},{"name":"Update Job Title","id":"dd91768b-cac7-4d39-bb46-5408b599a177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Job title

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/jobtitles/1","description":"

Updates an existing job title (referenced by the job title ID), returns the updated job title object with formatted data

Usage

\n
/jobtitles/{id}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Job title
external_identifier	string	50	No	UUID for 3rd party identification

Job title

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/jobtitles/abcd-1234/external","description":"

Updates an existing job title (referenced by the external_identifier), returns the updated job title object with formatted data

Usage

\n
/jobtitles/{external_identifier}/external
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Job title
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned job title object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
id	integer	Unique ID of the job title
name	string	Job title
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"133de04c-31b6-48be-92ff-12271dd0afd0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1917557f-c250-4190-8efe-e95d8ebcb0d3","type":"text/javascript","exec":[""]}}],"_postman_id":"d226f5b6-8888-44a2-a5ac-a5bb5617f31f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Job Roles","item":[{"name":"Create a Job Role","id":"6e056da8-3d1b-434b-bc79-ffcc5ae25e6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Job Role name

\n"},{"key":"description","value":"About the job role","type":"text","description":"

Description of the job role

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-roles","description":"

Creates a new job role, returns the saved job role object with formatted data

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	Yes	Job Role name
description	string	65,535	No	Description of the job role
external_identifier	string	50	No	UUID for 3rd party identification

Returns an array of job role objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","job-roles"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8f3fd89-fcb9-49ac-a644-14cd4d2bd930"},{"name":"Retrieve Job Role","id":"4b4b7d18-84a0-4d23-8af3-058637d67daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-roles/1","description":"

Get a single job role object, referenced by the job role ID

Usage

\n
/job-roles/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","job-roles","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b4b7d18-84a0-4d23-8af3-058637d67daa"},{"name":"Retrieve Job Role by External ID","id":"7cf06c6f-2b2b-43f4-a4f0-825ae0acfe3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-roles/abcd-1234/external","description":"

Get a single job role object, referenced by the external_identifier

Usage

\n
/job-roles/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","job-roles","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7cf06c6f-2b2b-43f4-a4f0-825ae0acfe3d"},{"name":"Update Job Role","id":"e5005e01-3f5b-4f48-80d2-dbda79e20cec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Job Role name

\n","disabled":true},{"key":"description","value":"About the job role","type":"text","description":"

Description of the job role

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-roles/1","description":"

Updates an existing job role (referenced by the job role ID), returns the updated job role object with formatted data

Usage

\n
/job-roles/{id}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Job Role name
description	string	65,535	No	Description of the job role
external_identifier	string	50	No	UUID for 3rd party identification

Job Role name

\n","disabled":true},{"key":"description","value":"About the job role","type":"text","description":"

Description of the job role

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-roles/abcd-1234/external","description":"

Updates an existing job role (referenced by the external_identifier), returns the updated job role object with formatted data

Usage

\n
/job-roles/{external_identifier}/external
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Job Role name
description	string	65,535	No	Description of the job role
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned course object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
id	integer	Unique ID for the job role
name	string	Job Role name
description	string	Job Role description
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"2ae31d2e-9c68-4d8e-b467-bee1b0391b49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a1cf2ad2-d7c6-4831-859f-a3dfe4f648e3","type":"text/javascript","exec":[""]}}],"_postman_id":"2b4ec6d7-5403-4385-9b3e-53efbf09f391","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Job Role Levels","item":[{"name":"Create a Job Role Level","id":"c50e318f-1c33-4420-bd0a-a6afcb490051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"job_role_id","value":"1","description":"

ID of Job Role

\n","type":"text"},{"key":"name","value":"Testing","type":"text","description":"

Job Role Level name

\n"},{"key":"description","value":"About the job role level","type":"text","description":"

Description of the job role level

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-role-levels","description":"

Creates a new job role level, returns the saved job role level object with formatted data

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
job_role_id	integer	ID of Job Role
name	string	200	Yes	Job Role Level name
description	string	65,535	No	Description of the job role level
external_identifier	string	50	No	UUID for 3rd party identification

Returns an array of job role level objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","job-role-levels"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a66517ca-428e-4214-aca7-e6262ac0b65e"},{"name":"Retrieve Job Role Level","id":"ae2ebf78-4023-432d-9ab2-1262aa9074d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-role-levels/1","description":"

Get a single job role level object, referenced by the job role level ID

Usage

\n
/job-role-levels/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","job-role-levels","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae2ebf78-4023-432d-9ab2-1262aa9074d0"},{"name":"Retrieve Job Role Level by External ID","id":"17d6394b-e0eb-41af-8c4f-23203b662a9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-role-levels/abcd-1234/external","description":"

Single job role level object, referenced by the external_identifier

Usage

\n
/job-role-levels/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","job-role-levels","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"17d6394b-e0eb-41af-8c4f-23203b662a9f"},{"name":"Update Job Role Level","id":"9086973f-479c-44b8-bb58-82ce65aaedd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Job Role Level name

\n","disabled":true},{"key":"description","value":"About the job role level","type":"text","description":"

Description of the job role level

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-role-levels/1","description":"

Updates an existing job role level (referenced by the job role level ID), returns the updated job role level object with formatted data

Usage

\n
/job-role-levels/{id}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Job Role Level name
description	string	65,535	No	Description of the job role level
external_identifier	string	50	No	UUID for 3rd party identification

Job Role Level name

\n","disabled":true},{"key":"description","value":"About the job role level","type":"text","description":"

Description of the job role level

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/job-role-levels/abcd-1234/external","description":"

Updates an existing job role level (referenced by the external_identifier), returns the updated job role level object with formatted data

Usage

\n
/job-role-levels/{external_identifier}/external
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Job Role Level name
description	string	65,535	No	Description of the job role level
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned job role level object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
id	integer	Unique ID for the job role level
name	string	Job Role Level name
description	string	Job Role Level description
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"6fb53089-65e9-4f6e-8b83-1cd0e7d8a821","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e8dd7240-8166-4a15-86c7-f105a6d4a00e","type":"text/javascript","exec":[""]}}],"_postman_id":"dd451af5-0684-4caa-a658-c0ab69c17196","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Groups","item":[{"name":"Create a Group","id":"65b926ce-f65f-44cc-ae18-08c38bbe2929","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Group name

\n"},{"key":"description","value":"About the group","type":"text","description":"

Description of the group

\n","disabled":true},{"key":"members","value":"","type":"text","description":"

Comma separated list of user IDs to assign as group members

\n","disabled":true},{"key":"features","value":"","type":"text","description":"

Comma separated list of features for the group, any of: \"learning\", \"cycle\"

\n","disabled":true},{"key":"cycle_start_date","value":"","type":"text","description":"

External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"cycle_end_date","value":"","type":"text","description":"

External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/groups","description":"

Creates a new group, returns the saved group object with formatted data

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	Yes	Group name
description	string	65,535	No	Description of the group
parent_id	integer	11	No	Parent group's ID
leads	integer(s)		No	Comma separated list of user IDs to assign as group leads
members	integer(s)		No	Comma separated list of user IDs to assign as group members
features	string		No	Comma separated list of features for the group, any of: \"learning\" \"cycle\"
cycle_id	integer	11	No	External cycle ID associated with the group
cycle_start_date	date	10	No	External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_end_date	date	10	No	External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_number	integer	4	No	External cycle number
external_identifier	string	50	No	UUID for 3rd party identification

Returns an array of group objects

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","groups"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a809b60-6e6b-4815-879d-92a8db33f1cc"},{"name":"Retrieve Group","id":"82c7e786-6aae-43ad-b514-7aadd6e7ab9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/groups/1","description":"

Updates an existing group (referenced by the group ID), returns the updated group object with formatted data

Usage

\n
/groups/{id}
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","groups","1"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"82c7e786-6aae-43ad-b514-7aadd6e7ab9f"},{"name":"Retrieve Group by External ID","id":"74ef53ba-a390-4a40-ac86-78af386dbdad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.YourPortalURL.com/wp-json/xy/v2/groups/abcd-1234/external","description":"

Updates an existing group (referenced by the external_identifier), returns the updated group object with formatted data

Usage

\n
/groups/{external_identifier}/external
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}},"urlObject":{"path":["wp-json/xy/v2","groups","abcd-1234","external"],"host":["https://www.YourPortalURL.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"74ef53ba-a390-4a40-ac86-78af386dbdad"},{"name":"Update Group","id":"a19e234f-c4c3-4af3-9fa3-06c966fc981c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Testing","type":"text","description":"

Group name

\n","disabled":true},{"key":"description","value":"About the group","type":"text","description":"

Description of the group

\n","disabled":true},{"key":"members","value":"","type":"text","description":"

Comma separated list of user IDs to assign as group members.\nGroup members can be removed by leaving them off the list.\nAn empty value will remove all group members.\nIf no changes are required, either pass the existing IDs or do not pass \"members\" in the request.

\n","disabled":true},{"key":"features","value":"","type":"text","description":"

Comma separated list of features for the group, any of: \"learning\", \"cycle\"

\n","disabled":true},{"key":"cycle_start_date","value":"","type":"text","description":"

External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"cycle_end_date","value":"","type":"text","description":"

External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/groups/1","description":"

Updates an existing group (referenced by the group ID), returns the updated group object with formatted data

Usage

\n
/groups/{id}
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Group name
description	string	65,535	No	Description of the group
parent_id	integer	11	No	Parent group's ID
leads	integer(s)		No	Comma separated list of user IDs to assign as group leads. Group leads can be removed by leaving them off the list. An empty value will remove all group leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
members	integer(s)		No	Comma separated list of user IDs to assign as group members. Group members can be removed by leaving them off the list. An empty value will remove all group members. If no changes are required, either pass the existing IDs or do not pass \"members\" in the request.
features	string		No	Comma separated list of features for the group, any of: \"learning\" \"cycle\"
cycle_id	integer	11	No	External cycle ID associated with the group
cycle_start_date	date	10	No	External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_end_date	date	10	No	External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_number	integer	4	No	External cycle number
external_identifier	string	50	No	UUID for 3rd party identification

Group name

\n","disabled":true},{"key":"description","value":"About the group","type":"text","description":"

Description of the group

\n","disabled":true},{"key":"members","value":"","type":"text","description":"

\n","disabled":true},{"key":"features","value":"","type":"text","description":"

Comma separated list of features for the group, any of: \"learning\", \"cycle\"

\n","disabled":true},{"key":"cycle_start_date","value":"","type":"text","description":"

External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"cycle_end_date","value":"","type":"text","description":"

External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)

\n","disabled":true},{"key":"external_identifier","value":"abcd-1234","type":"text","description":"

UUID for 3rd party identification

\n","disabled":true}]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/groups/abcd-1234/external","description":"

Updates an existing group (referenced by the external_identifier), returns the updated group object with formatted data

Usage

\n
/groups/{external_identifier}/external
\n

Arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Max Length	Required?	Description
name	string	200	No, unless passing \"name\" in the request, then it cannot be empty	Group name
description	string	65,535	No	Description of the group
parent_id	integer	11	No	Parent group's ID
leads	integer(s)		No	Comma separated list of user IDs to assign as group leads. Group leads can be removed by leaving them off the list. An empty value will remove all group leads. If no changes are required, either pass the existing IDs or do not pass \"leads\" in the request.
members	integer(s)		No	Comma separated list of user IDs to assign as group members. Group members can be removed by leaving them off the list. An empty value will remove all group members. If no changes are required, either pass the existing IDs or do not pass \"members\" in the request.
features	string		No	Comma separated list of features for the group, any of: \"learning\" \"cycle\"
cycle_id	integer	11	No	External cycle ID associated with the group
cycle_start_date	date	10	No	External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_end_date	date	10	No	External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_number	integer	4	No	External cycle number
external_identifier	string	50	No	UUID for 3rd party identification

Schema

The schema describes the format of a returned group object.

Object Key	Data Type	Description
id	integer	Unique ID for the group
name	string	Group name
description	string	Group description
parent	object	Data for a parent group
parent.id	integer	ID of the parent group (0 if the group has no parent)
parent.name	string	Name of the parent group
leads	array	User data for each group lead
lead.id (for each lead)	integer	User ID of the group lead
lead.name (for each lead)	string	Name of the group lead
members	array	User data for each group member
member.id (for each member)	integer	User ID of the group member
member.name (for each member)	string	Name of the group member
features	string	Comma separated list of features for the group, any of: \"learning\" \"cycle\"
cycle_id	integer	External cycle ID associated with the group
cycle_start_date	date	External cycle start date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_end_date	date	External cycle end date, formatted as \"yyyy-mm-dd\" (UTC)
cycle_number	integer	External cycle number
external_identifier	string	UUID for 3rd party identification

","event":[{"listen":"prerequest","script":{"id":"a8da7a0d-07ef-4d23-b791-57cb36adbed6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa974bcd-91ea-490a-91f9-269ddb1efbaa","type":"text/javascript","exec":[""]}}],"_postman_id":"0b7af252-7e6e-494d-aed1-7bb594dcfa7f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}},{"name":"Settings","item":[{"name":"Regenerate API Key","event":[{"listen":"test","script":{"id":"dfb5e7a2-5170-4493-91fa-2e20b7b1f5b4","exec":["// fill the newly generated API key in the current environment\r","let response = JSON.parse(pm.response.text());\r","if (response.hasOwnProperty('key')) {\r"," pm.environment.set(\"apiKey\", response.key);\r","}"],"type":"text/javascript"}}],"id":"4064c40e-a99e-4593-97d5-c21b3c883ebe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://www.YourPortalURL.com/wp-json/xy/v2/settings/apikey/regenerate","description":"

Generates and returns a new API key. Be sure to save this key, as the old key will be immediately invalidated.

Schema

The schema describes the format of a returned API key.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Object Key	Data Type	Description
key	string	API key

","event":[{"listen":"prerequest","script":{"id":"3b925a19-1e02-4974-abea-779cb406d794","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59dfbde5-7f74-4247-9292-b2e0b3ff3d2c","type":"text/javascript","exec":[""]}}],"_postman_id":"f67adecb-e037-4921-9362-bfd203e69c36","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]},"isInherited":true,"source":{"_postman_id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","id":"266b6657-5ccd-4944-8b5b-8f60e5516e45","name":"XY REST API v2","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"your-api-key"}]}},"event":[{"listen":"prerequest","script":{"id":"a2d0b280-f8cb-4e36-98eb-244b621596dd","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"9441c54d-9171-41ff-95ab-007b09fdf740","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"apiKey","value":"your-api-key"},{"key":"host","value":"https://www.YourPortalURL.com"},{"key":"base","value":"wp-json/xy/v2"},{"key":"apiRef","value":"x-api-key"}]}