{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.r1learning.com" } ], "info": { "name": "R1Disover API", "_postman_id": "705a39f7-ccd8-486d-85ab-ff961edc29ed", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Company Management", "description": "", "item": [ { "name": "List Companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/companies", "query": [ { "key": "companyId", "value": "0", "description": "optional The id of the company (0 returns all companies).", "disabled": true }, { "key": "stripeCustomerId", "value": "", "description": "optional The Stripe customer ID to filter companies. Example:", "disabled": true }, { "key": "stripeSubscriptionId", "value": "", "description": "optional The Stripe subscription ID to filter companies. Example:", "disabled": true }, { "key": "page", "value": "1", "description": "optional The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "optional Number of records to return, default 50, max 100.", "disabled": false }, { "key": "sortby", "value": "1", "description": "optional Sort companies by (1: Oldest, 2: Newest, 3: Alphabetical, 4: Reverse Alphabetical), defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/companies?companyId=0&stripeCustomerId=&stripeSubscriptionId=&page=1&limit=50&sortby=1" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"company_list\": [\n {\n \"id\": 11017,\n \"name\": \"R1 Learning\",\n \"total_licenses\": 200,\n \"assigned_licenses\": 99,\n \"available_licenses\": 101,\n \"license_renewal_date\": \"2025-12-31\",\n \"status\": \"published\"\n },\n {\n \"id\": 12138,\n \"name\": \"R2 Learning\",\n \"total_licenses\": 100,\n \"assigned_licenses\": 90,\n \"available_licenses\": 10,\n \"license_renewal_date\": \"2025-09-30\",\n \"status\": \"published\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Create Company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/companies", "query": [], "raw": "{{baseUrl}}\/api\/v2\/companies" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme Corp\",\"address1\":\"123 Main St\",\"address2\":\"Suite 456\",\"city\":\"New York\",\"state\":\"NY\",\"zip\":\"10001\",\"country\":\"US\",\"phone\":\"555-123-4567\",\"email\":\"contact@r1.com\",\"status\":\"published\",\"total_licenses\":100,\"license_duration\":\"1-year\",\"subscription_type\":\"basic\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Company created successfully\",\n \"data\": {\n \"id\": 99,\n \"name\": \"FB Test Comp 3\",\n \"address1\": \"15 North avenue\",\n \"address2\": \"Suite 100\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"zip\": \"60610\",\n \"country\": \"US\",\n \"status\": \"published\",\n \"total_licenses\": \"10\",\n \"email1\": \"contact@example.com\",\n \"license_renewal_date\": \"2025-10-01 00:41:10\"\n }\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Update Company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/companies\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/companies\/:id", "variable": [ { "id": "id", "key": "id", "value": 1234, "description": "The ID of the company to update." } ] }, "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"published\",\"total_licenses\":10,\"license_renewal_date\":\"2025-01-01\",\"subscription_type\":\"individual\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Company updated successfully\",\n \"data\": {\n \"id\": 10231,\n \"name\": \"Example Company\",\n \"status\": \"published\",\n \"total_licenses\": \"11\",\n \"license_renewal_date\": \"2025-10-01\"\n }\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" }, { "header": [], "code": 422, "body": "{\n \"error\": 1,\n \"message\": \"Total licenses cannot be less than currently assigned licenses\",\n \"details\": \"You have 198 licenses assigned, please unassign licenses to reduce the total below 198.\"\n}", "name": "Validation Error" } ] }, { "name": "List Company Topics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/companies\/topics", "query": [ { "key": "companyId", "value": "0", "description": "The id of the company (0 returns all companies).", "disabled": false }, { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "sortby", "value": "1", "description": "Sort companies by (1: Oldest, 2: Newest, 3: Alphabetical, 4: Reverse Alphabetical).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/companies\/topics?companyId=0&page=1&limit=50&sortby=1" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 2,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\"\n },\n \"topic_list\": [\n {\n \"company_id\": 17532,\n \"topics\": [\n {\n \"topic_id\": 1123,\n \"name\": \"Stages of Change (SUD)\",\n \"video_url\": \"http:\/\/discover.r1learning.com\/video-library\/video\/****\"\n },\n {\n \"topic_id\": 3321,\n \"name\": \"Healthy Boundaries\",\n \"video_url\": \"http:\/\/discover.r1learning.com\/video-library\/video\/****\"\n }\n ]\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Company Activities", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/companies\/activities", "query": [ { "key": "companyId", "value": "0", "description": "The id of the company, default 0 returns all companies.", "disabled": true }, { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "sortby", "value": "1", "description": "Sort companies by (1: Oldest, 2: Newest, 3: Alphabetical, 4: Reverse Alphabetical).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/companies\/activities?companyId=0&page=1&limit=50&sortby=1" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 4,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\"\n },\n \"data\": [\n {\n \"company_id\": 3124,\n \"activity_list\": [\n {\n \"topic_id\": 123,\n \"topic_name\": \"Stages of Change (SUD)\",\n \"activities\": [\n {\n \"id\": 71,\n \"name\": \"Identify My Stage of Change\",\n \"type\": \"sorting_cards\",\n \"activity_url\": \"http:\/\/discover.r1learning.com\/activity****\"\n },\n {\n \"id\": 98,\n \"name\": \"Explore the Stages of Change Model\",\n \"type\": \"overview_definition_cards\",\n \"activity_url\": \"http:\/\/discover.r1learning.com\/activity****\"\n }\n ]\n },\n {\n \"topic_id\": 242,\n \"topic_name\": \"Phases of Addiction\",\n \"activities\": [\n {\n \"id\": 27,\n \"name\": \"Identify My Phase of Addiction\",\n \"type\": \"sorting_cards\",\n \"activity_url\": \"http:\/\/discover.r1learning.com\/activity****\"\n },\n {\n \"id\": 63,\n \"name\": \"Explore the Phases of Addiction Model\",\n \"type\": \"overview_definition_cards\",\n \"activity_url\": \"http:\/\/discover.r1learning.com\/activity****\"\n }\n ]\n }\n\t\t\t]\n\t\t}\n\t]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] } ] }, { "name": "Locations & Programs", "description": "", "item": [ { "name": "List Company Locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/locations\/:companyId", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "sortby", "value": "1", "description": "Sort companies by (1: Oldest, 2: Newest).", "disabled": false }, { "key": "locationOrder", "value": "1", "description": "Order of locations (1: Oldest, 2: Newest, 3: Alphabetical, 4: Reverse Alphabetical).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/locations\/:companyId?page=1&limit=50&sortby=1&locationOrder=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 0, "description": "The company id (0 returns all companies)." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"location_list\": [\n {\n \"company_id\": 12345,\n \"locations\": [\n {\n \"id\": 1273,\n \"location_name\": \"R1 Location 1\",\n \"status\": \"published\"\n },\n {\n \"id\": 5692,\n \"location_name\": \"R1 Location 2\",\n \"status\": \"published\"\n }\n ]\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Create\/Update Location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/locations\/:companyId", "query": [ { "key": "id", "value": "", "description": "The ID of the location to update. Leave blank for creating a new location. Example:", "disabled": true }, { "key": "location_name", "value": "Main Office", "description": "The name of the location.", "disabled": false }, { "key": "address1", "value": "123 Main St", "description": "The primary address.", "disabled": false }, { "key": "address2", "value": "Apt 4B", "description": "The secondary address (optional).", "disabled": false }, { "key": "city", "value": "New York", "description": "The city where the facility is located.", "disabled": false }, { "key": "state", "value": "NY", "description": "The state where the facility is located.", "disabled": false }, { "key": "zip", "value": "10001", "description": "The zip code of the facility.", "disabled": false }, { "key": "country", "value": "US", "description": "The 2-digit country code for the facility (See List Countries endpoint).", "disabled": false }, { "key": "phone1", "value": "123-456-7890", "description": "The contact phone number for the location.", "disabled": false }, { "key": "email1", "value": "info@company.com", "description": "The contact email for the location.", "disabled": false }, { "key": "status", "value": "published", "description": "The status of the location (published, pending, draft).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/locations\/:companyId?id=&location_name=Main%20Office&address1=123%20Main%20St&address2=Apt%204B&city=New%20York&state=NY&zip=10001&country=US&phone1=123-456-7890&email1=info%40company.com&status=published", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The ID of the company." } ] }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Location created successfully\",\n \"data\": {\n \"id\": 185672,\n \"location_name\": \"Main Office\",\n \"company_item_id\": \"1234\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"phone1\": \"123-456-7890\",\n \"email1\": \"info@company.com\",\n \"created_at\": \"2024-09-14T03:47:35.000000Z\",\n \"updated_at\": \"2024-09-14T03:47:35.000000Z\"\n }\n}", "name": "success" }, { "header": [], "code": 201, "body": "{\n \"message\": \"Location updated successfully\",\n \"data\": 1\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Parent Programs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/programs\/parent", "query": [ { "key": "page", "value": "1", "description": "The current page number. Default: 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return. Default: 50, Max: 100.", "disabled": false }, { "key": "sortBy", "value": "1", "description": "Order of programs (1: Oldest, 2: Newest, 3: Alphabetical, 4: Reverse Alphabetical).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/programs\/parent?page=1&limit=50&sortBy=1" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 3,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"parent_program_list\": [\n {\n \"id\": 1,\n \"name\": \"ASAM Level .5 \u2013 Early Intervention\",\n \"status\": \"published\"\n },\n {\n \"id\": 2,\n \"name\": \"ASAM Level 1 \u2013 Outpatient\",\n \"status\": \"published\"\n },\n {\n \"id\": 3,\n \"name\": \"ASAM Level 2.1 \u2013 Intensive Outpatient\",\n \"status\": \"published\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Company Programs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/programs\/:companyId", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "sortby", "value": "1", "description": "Sort companies by (1: Oldest, 2: Newest).", "disabled": false }, { "key": "programOrder", "value": "1", "description": "Order of programs (1: Oldest, 2: Newest, 3: Alphabetical, 4: Reverse Alphabetical).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/programs\/:companyId?page=1&limit=50&sortby=1&programOrder=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 0, "description": "The company id (0 returns all companies)." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"program_list\": [\n {\n \"company_id\": 1432,\n \"programs\": [\n {\n \"program_id\": 1937,\n \"program_name\": \"Detox\",\n \"program_parent_id\": 1,\n \"program_parent_name\": \"ASAM Level .5 \u2013 Early Intervention\",\n \"status\": \"published\"\n },\n {\n \"program_id\": 4526,\n \"program_name\": \"PHP\",\n \"program_parent_id\": 4,\n \"program_parent_name\": \"ASAM Level 2.5 \u2013 Partial Hospitalization\",\n \"status\": \"published\"\n }\n ]\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Create\/Update Program", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/programs\/:companyId", "query": [ { "key": "id", "value": "", "description": "The ID of the program to update (if updating, leave blank to create). Example:", "disabled": true }, { "key": "name", "value": "\"New Program\"", "description": "The name of the program.", "disabled": false }, { "key": "parent_id", "value": "1", "description": "The ID of the parent program.", "disabled": false }, { "key": "status", "value": "published", "description": "string The status of the program (published, pending, draft).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/programs\/:companyId?id=&name=%22New%20Program%22&parent_id=1&status=published", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The ID of the company." } ] }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"The program \\\"New Program\\\" created successfully\",\n \"data\": {\n \"id\": 18827,\n \"company_id\": \"1432\",\n \"name\": \"New Program\",\n \"parent_id\": \"2\",\n \"status\": \"published\",\n \"created_at\": \"2024-09-14T04:41:20.000000Z\",\n \"updated_at\": \"2024-09-14T04:41:20.000000Z\"\n }\n}", "name": "Success" }, { "header": [], "code": 201, "body": "{\n \"message\": \"The program \\\"New Program\\\" updated successfully\",\n \"data\": 1\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] } ] }, { "name": "User Management", "description": "", "item": [ { "name": "List Company Users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/users\/:companyId", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "maxDays", "value": "0", "description": "Pull records from last x days, default 0 which returns all records.", "disabled": true }, { "key": "userStatus", "value": "0", "description": "1 = active, 2 = inactive, default 0 which returns all users.", "disabled": true }, { "key": "uniqueID", "value": "", "description": "stringThe unique ID of the user from the integration partner system. Example:", "disabled": true }, { "key": "location_id", "value": "", "description": "Pull users from a location, defaults blank to returns all records. Example:", "disabled": true }, { "key": "program_id", "value": "", "description": "Pull users from a Program, defaults blank to returns all records. Example:", "disabled": true }, { "key": "sortby", "value": "1", "description": "User order (1: Oldest, 2: Newest, 3: Least Recently Active, 4: Recently Active).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/users\/:companyId?page=1&limit=50&maxDays=0&userStatus=0&uniqueID=&location_id=&program_id=&sortby=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 0, "description": "The company id (0 returns all companies)." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 2,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\",\n \"max_days\": \"400\"\n },\n \"user_list\": [\n {\n \"company_id\": 127,\n \"users\": [\n {\n \"user_id\": 29673,\n \"email\": \"acase@example.com\",\n \"username\": \"acase@example.com\",\n \"company_username\": null,\n \"unique_id\": \"compid-user-000000000000946\",\n \"status\": \"active\",\n \"location_name\": \"R1 Location 1\",\n \"program_name\": \"Sample Program\",\n \"practitioner_email\": \"practitioner@example.com\",\n \"member_updated_at\": \"2023-07-20T14:21:17.000000Z\",\n \"last_activity_date\": \"2023-08-25T11:06:32.000000Z\"\n }\n ]\n },\n {\n \"company_id\": 393,\n \"users\": [\n {\n \"user_id\": 21333,\n \"email\": \"user@example.com\",\n \"username\": \"user@example.com\",\n \"company_username\": null,\n \"unique_id\": \"compid-user-000000000002341\",\n \"status\": \"active\",\n \"location_name\": \"Company Location 2\",\n \"program_name\": \"PHP\",\n \"practitioner_email\": \"practitioner@example.com\",\n \"member_updated_at\": \"2023-06-11T13:06:59.000000Z\",\n \"last_activity_date\": \"2023-09-15T12:13:49.000000Z\"\n }\n ]\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Create\/Update User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/users\/:companyId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/users\/:companyId", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The ID of the company." } ] }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"client_id\":\"r1-user-123456-01\",\"username\":\"user123\",\"company_username\":\"user123\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"client_email\":\"xyz@example.com\",\"client_location\":\"AZ Treatment Center\",\"client_program\":\"Virtual Outatient\",\"client_practitioner\":\"practitioner_email@example.com\",\"client_status\":\"active\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": 0,\n \"message\": \"User created successfully\",\n \"data\": {\n \"id\": 67890,\n \"unique_id\": \"abcxyz123456\",\n \"username\": \"johndoe\",\n \"company_username\": \"johndoe_company\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"client_email\": \"johndoe@example.com\"\n }\n}\n", "name": "Success" }, { "header": [], "code": 201, "body": "{\n \"error\": 0,\n \"message\": \"User updated successfully!\",\n \"data\": [\n {\n \"id\": 123456,\n \"unique_id\": \"test-user-1234\",\n \"username\": \"user123456\",\n \"company_username\": \"\",\n \"first_name\": \"User\",\n \"last_name\": \"Example\",\n \"email\": \"user123456@example.com\",\n \"location\": \"Sample Location\",\n \"practitioner\": \"practitioner@example.com\",\n \"program\": \"Sample Program\",\n \"status\": \"active\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"error\": 1,\n \"message\": \"User not found\",\n \"details\": \"The requested user with Unique ID 'abcxyz' does not exist or is not associated with the given company.\"\n }\n ", "name": "User Not Found" } ] }, { "name": "List Admin Roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/admins\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v2\/admins\/roles" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 4,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"admin_roles\": [\n {\n \"name\": \"Admin\",\n \"description\": \"View, Edit, and Create Users at same Program & Location\"\n },\n {\n \"name\": \"Admin-Read\",\n \"description\": \"View (not Edit) Users at same Program & Location\"\n },\n {\n \"name\": \"Lead Admin\",\n \"description\": \"View, Edit, and Create Admins and Users at same Program & Location\"\n },\n {\n \"name\": \"Lead Admin - Read\",\n \"description\": \"View (not Edit) Admins and Users at same Program & Location\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Company Admins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/admins\/:companyId", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "maxDays", "value": "0", "description": "Pull records from last x days, default 0 which returns all records.", "disabled": true }, { "key": "userStatus", "value": "", "description": "1 = active, 2 = inactive, default 0\/blank which returns all users. Example:", "disabled": true }, { "key": "uniqueID", "value": "", "description": "The unique ID of the admin from the integration partner system. Example:", "disabled": true }, { "key": "location_id", "value": "", "description": "Pull users from a location, defaults blank to returns all records. Example:", "disabled": true }, { "key": "program_id", "value": "", "description": "Pull users from a Program, defaults blank to returns all records. Example:", "disabled": true }, { "key": "practitioners", "value": "", "description": "1 = Pull only practitioners, 0\/blank (default) returns all users. Example:", "disabled": true }, { "key": "sortby", "value": "1", "description": "User order (1: Oldest, 2: Newest, 3: Least Recently Active, 4: Recently Active).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/admins\/:companyId?page=1&limit=50&maxDays=0&userStatus=&uniqueID=&location_id=&program_id=&practitioners=&sortby=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 0, "description": "The company id (0 returns all companies)." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 1,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\",\n \"max_days\": \"0\"\n },\n \"admin_list\": [\n {\n \"company_id\": 612,\n \"admins\": [\n {\n \"user_id\": 12345,\n \"email\": \"john.smith@r1.com\",\n \"username\": \"johnsmith\",\n \"unique_id\": \"admin-r1-000000000012345\",\n \"admin_type\": \"Company Admin\",\n \"role_name\": \"Super Admin\",\n \"default_location\": \"R1 Location 1\",\n \"default_program\": \"PHP\",\n \"status\": \"active\",\n \"member_updated_at\": \"2024-09-15T00:51:20.000000Z\",\n \"last_activity_date\": \"2024-01-07T16:50:19.000000Z\"\n }\n ]\n }\n ]\n}\n", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Create\/Update Admin", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/admins\/:companyId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/admins\/:companyId", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The ID of the company." } ] }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"admin_id\":\"r1-admin-123456-01\",\"admin_email\":\"xyz@example.com\",\"admin_username\":\"admin123\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"admin_role\":\"\\\"Admin-Read\\\"\",\"admin_type\":\"Practitioner\",\"admin_location\":\"AZ Treatment Center\",\"admin_program\":\"PHP\",\"admin_status\":\"active\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": 0,\n \"message\": \"Admin created successfully\",\n \"data\": {\n \"unique_id\": \"abcxyz\",\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"admin_email\": \"johndoe@example.com\",\n \"admin_role\": \"Admin-Read\",\n \"admin_type\": \"Company Admin\",\n \"admin_location\": \"R1 Location 1\",\n \"admin_program\": \"General\",\n \"admin_status\": \"active\",\n \"created_at\": \"2024-08-30T14:30:00Z\"\n }\n}\n", "name": "Success" }, { "header": [], "code": 201, "body": "{\n \"error\": 0,\n \"message\": \"Admin updated successfully\",\n \"data\": [\n {\n \"unique_id\": \"r1-admin-example\",\n \"username\": \"AdminExampele\",\n \"first_name\": \"Admin\",\n \"last_name\": \"Example\",\n \"email\": \"admin@example.com\",\n \"role\": \"Admin-Read\",\n \"status\": \"active\"\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"error\": 1,\n \"message\": \"Admin not found\",\n \"details\": \"The requested admin with UniqueID 'abcxyz' does not exist or is not associated with the given company.\"\n }\n ", "name": "Admin Not Found" } ] }, { "name": "Update Admin\/User Unique ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/users\/:id\/uniqueId", "query": [], "raw": "{{baseUrl}}\/api\/v2\/users\/:id\/uniqueId", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "The R1 ID of the user\/admin to update." } ] }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"unique_id\":\"r1-user-1234\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Unique ID Updated Successfully\",\n \"data\": {\n \"id\": 32687,\n \"unique_id\": \"r1-admin-example\"\n }\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"error\": 1,\n \"message\": \"User not found\",\n \"details\": \"User with R1 ID '123' does not exist or is associated with a company outside your access.\"\n }\n ", "name": "User Not Found" } ] }, { "name": "Check Global Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/usernames\/check\/global\/:username", "query": [], "raw": "{{baseUrl}}\/api\/v2\/usernames\/check\/global\/:username", "variable": [ { "id": "username", "key": "username", "value": "xyz123", "description": "Global username to check." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n{\n \"username\": \"testUser\",\n \"is_available\": false,\n \"message\": \"Username is not available\"\n},\n{\n \"username\": \"testUser2\",\n \"is_available\": true,\n \"message\": \"Username is available\"\n}\n]", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "Check Company Username", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/usernames\/check\/company\/:companyId\/:companyUsername", "query": [], "raw": "{{baseUrl}}\/api\/v2\/usernames\/check\/company\/:companyId\/:companyUsername", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The ID of the company." }, { "id": "companyUsername", "key": "companyUsername", "value": "xyz123", "description": "Company-specific username to check." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\n \"company_id\": \"1\",\n \"company_username\": \"FB1234\",\n \"is_available\": true,\n \"message\": \"base.user_is_available_for_this_company\"\n},\n{\n \"company_id\": \"1\",\n \"company_username\": \"FB12345\",\n \"is_available\": false,\n \"message\": \"Username \\\"FB12345\\\" is already taken for this company\"\n}]", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] } ] }, { "name": "Activity Results", "description": "", "item": [ { "name": "List Activities", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/activities\/company\/:companyId\/details", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "maxDays", "value": "0", "description": "Pull records from last x days, default 0 which returns all records.", "disabled": true }, { "key": "userId", "value": "", "description": "The R1 ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "uniqueId", "value": "", "description": "The integration partner ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "userActivityId", "value": "", "description": "The ID of the specific user activity. If provided, returns details for this activity only. Example:", "disabled": true }, { "key": "userType", "value": "1", "description": "The type of user. 0 for all, 1 for Users, 2 for Admins.", "disabled": false }, { "key": "activityType", "value": "0", "description": "The type of activity. 0 for all, 1 for Pyramid, 2 for Explore.", "disabled": true }, { "key": "topicId", "value": "", "description": "The ID of the topic. If provided, returns all activities for this topic in the specified company. Example:", "disabled": true }, { "key": "activityId", "value": "", "description": "The ID of the activity. If provided, returns all activities for this activity in the specified company. Example:", "disabled": true }, { "key": "sortby", "value": "1", "description": "User order (1: Oldest, 2: Newest).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/activities\/company\/:companyId\/details?page=1&limit=50&maxDays=0&userId=&uniqueId=&userActivityId=&userType=1&activityType=0&topicId=&activityId=&sortby=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The id of the company." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 1,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\",\n \"max_days\": \"0\",\n \"company_id\": \"4121\",\n \"***comment\": \"UserId\/ActivityId visible if included in query\",\n\t\t\"user_id\": \"21267\",\n\t\t\"user_activity_id\": \"154340\"\n },\n \"activities\": [\n {\n \"id\": 154340,\n \"user_id\": 21267,\n \"company_id\": 4121,\n \"topic_name\": \"Stages of Change (SUD)\",\n \"activity_id\": 312,\n \"activity_name\": \"Identify My Stage of Change\",\n \"activity_type\": \"sorting_cards\",\n \"created_at\": \"2024-04-20T15:03:11.000000Z\",\n \"updated_at\": \"2024-04-20T21:21:01.000000Z\",\n \"completed_date\": \"2024-04-20T21:21:01.000000Z\",\n \"completed_status\": \"Activity Completed\",\n \"report_url\": \"http:\/\/discover.r1learning.com\/stages****\",\n \"video_completed\": false\n }\n\t]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Activity Yes\/No Cards", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/activities\/company\/:companyId\/cards", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "maxDays", "value": "0", "description": "Pull records from last x days, default 0 which returns all records.", "disabled": true }, { "key": "userId", "value": "", "description": "The R1 ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "uniqueId", "value": "", "description": "The integration partner ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "userActivityId", "value": "", "description": "The ID of the specific user activity. If provided, returns details for this activity only. Example:", "disabled": true }, { "key": "userType", "value": "1", "description": "The type of user. 0 for all, 1 for Users, 2 for Admins.", "disabled": false }, { "key": "activityType", "value": "0", "description": "The type of activity. 0 for all, 1 for Pyramid, 2 for Definition.", "disabled": true }, { "key": "topicId", "value": "", "description": "The ID of the topic. If provided, returns all activities for this topic in the specified company. Example:", "disabled": true }, { "key": "activityId", "value": "", "description": "The ID of the activity. If provided, returns all activities for this activity in the specified company. Example:", "disabled": true }, { "key": "sortby", "value": "1", "description": "User order (1: Oldest, 2: Newest).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/activities\/company\/:companyId\/cards?page=1&limit=50&maxDays=0&userId=&uniqueId=&userActivityId=&userType=1&activityType=0&topicId=&activityId=&sortby=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The id of the company." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 1,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\",\n \"max_days\": \"0\",\n \"company_id\": \"1\"\n },\n \"activities\": [\n {\n \"user_activity_id\": 15205,\n \"user_id\": 21123,\n \"company_id\": 123123,\n \"topic_id\": 111222,\n \"cards\": {\n \"yes_cards\": [\n {\n \"selected_id\": 1,\n \"model_definition\": \"Maintenance\",\n \"text\": \"I practice mindfulness and patience to support my substance-free lifestyle\"\n },\n {\n \"selected_id\": 2,\n \"model_definition\": \"Maintenance\",\n \"text\": \"I am grateful for quitting and living a substance-free life\"\n }\n ],\n \"no_cards\": [\n {\n \"selected_id\": 1,\n \"model_definition\": \"Preparation\",\n \"text\": \"I have recently told others about my plans to quit\"\n },\n {\n \"selected_id\": 2,\n \"model_definition\": \"Pre Contemplation\",\n \"text\": \"There is nothing I really need to change about my drinking or using;I am a fairly normal drinker or user \"\n }\n ]\n }\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Activity Final Cards", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/activities\/company\/:companyId\/final-cards", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "maxDays", "value": "0", "description": "Pull records from last x days, default 0 which returns all records.", "disabled": true }, { "key": "userId", "value": "", "description": "The R1 ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "uniqueId", "value": "", "description": "The integration partner ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "userActivityId", "value": "", "description": "The ID of the specific user activity. If provided, returns details for this activity only. Example:", "disabled": true }, { "key": "userType", "value": "1", "description": "The type of user. 0 for all, 1 for Users, 2 for Admins.", "disabled": false }, { "key": "activityType", "value": "0", "description": "The type of activity. 0 for all, 1 for Pyramid, 2 for Explore.", "disabled": true }, { "key": "topicId", "value": "", "description": "The ID of the topic. If provided, returns all activities for this topic in the specified company. Example:", "disabled": true }, { "key": "activityId", "value": "", "description": "The ID of the activity. If provided, returns all activities for this activity in the specified company. Example:", "disabled": true }, { "key": "sortby", "value": "1", "description": "User order (1: Oldest, 2: Newest).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/activities\/company\/:companyId\/final-cards?page=1&limit=50&maxDays=0&userId=&uniqueId=&userActivityId=&userType=1&activityType=0&topicId=&activityId=&sortby=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The id of the company." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 1,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\",\n \"max_days\": \"0\",\n \"company_id\": \"4132\",\n\t\t\"***comment\": \"UserId\/ActivityId visible if included in query\",\n\t\t\"user_id\": \"2157\",\n\t\t\"user_activity_id\": \"15026\"\n },\n \"activities\": [\n {\n \"user_activity_id\": 15026,\n \"user_id\": 2157,\n \"company_id\": 4132,\n \"cards\": [\n {\n \"pyramid_id\": 1,\n \"model_category\": \"Maintenance\",\n \"card_detail\": \"I love my substance-free life and act daily to keep it\"\n },\n {\n \"pyramid_id\": 2,\n \"model_category\": \"Maintenance\",\n \"card_detail\": \"I practice mindfulness and patience to support my substance-free lifestyle\"\n },\n {\n \"pyramid_id\": 3,\n \"model_category\": \"Maintenance\",\n \"card_detail\": \"I am grateful for quitting and living a substance-free life\"\n },\n {\n \"pyramid_id\": 4,\n \"model_category\": \"Maintenance\",\n \"card_detail\": \"I participate in healthy activities to avoid stress and reduce anxiety\"\n },\n {\n \"pyramid_id\": 5,\n \"model_category\": \"Maintenance\",\n \"card_detail\": \"I am managing risk situations and\/or temptations (triggering people, places, things, and situations) \"\n },\n {\n \"pyramid_id\": 6,\n \"model_category\": \"Maintenance\",\n \"card_detail\": \"I am serving and supporting others who are not using substances\"\n },\n {\n \"pyramid_id\": 7,\n \"model_category\": \"Action\",\n \"card_detail\": \"I am asking others for help\"\n },\n {\n \"pyramid_id\": 8,\n \"model_category\": \"Action\",\n \"card_detail\": \"I am connecting with others and building a new network of healthy non-drinking or using friends\"\n },\n {\n \"pyramid_id\": 9,\n \"model_category\": \"Contemplation\",\n \"card_detail\": \"I can see the benefits of quitting more clearly\"\n },\n {\n \"pyramid_id\": 10,\n \"model_category\": \"Action\",\n \"card_detail\": \"I am not drinking or using, one day at a time\"\n }\n ]\n }\n\t]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Activity Q&As", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/activities\/company\/:companyId\/questions", "query": [ { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false }, { "key": "maxDays", "value": "0", "description": "Pull records from last x days, default 0 which returns all records.", "disabled": true }, { "key": "userId", "value": "", "description": "The ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "uniqueId", "value": "", "description": "The integration partner ID of the user. If provided, returns all activities for this user in the specified company. Example:", "disabled": true }, { "key": "userActivityId", "value": "", "description": "The ID of the specific user activity. If provided, returns details for this activity only. Example:", "disabled": true }, { "key": "userType", "value": "1", "description": "The type of user. 0 for all, 1 for Users, 2 for Admins.", "disabled": false }, { "key": "activityType", "value": "0", "description": "The type of activity. 0 for all, 1 for Pyramid, 2 for Definition.", "disabled": true }, { "key": "topicId", "value": "", "description": "The ID of the topic. If provided, returns all activities for this topic in the specified company. Example:", "disabled": true }, { "key": "activityId", "value": "", "description": "The ID of the activity. If provided, returns all activities for this activity in the specified company. Example:", "disabled": true }, { "key": "sortby", "value": "1", "description": "User order (1: Oldest, 2: Newest).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/activities\/company\/:companyId\/questions?page=1&limit=50&maxDays=0&userId=&uniqueId=&userActivityId=&userType=1&activityType=0&topicId=&activityId=&sortby=1", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The id of the company." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 109,\n \"total_pages\": 3,\n \"current_page\": \"1\",\n \"per_page\": \"50\",\n \"max_days\": \"0\",\n \"company_id\": \"2296\",\n \"***comment\": \"UserId\/ActivityId visible if included in query\",\n\t\t\"user_id\": \"32579\",\n\t\t\"user_activity_id\": \"276321\"\n },\n \"activities\": [\n {\n \"user_activity_id\": 276321,\n \"user_id\": 32579,\n \"company_id\": 2296,\n \"questions\": [\n {\n \"question_id\": 1,\n \"question\": \"What substance did you examine in this activity?\",\n \"question_type\": \"radio\",\n \"answer\": \"Alcohol \u2013 beer, wine, liquor, hard cider, hard seltzer\"\n },\n {\n \"question_id\": 2,\n \"question\": \"As you think about what you've learned and your results, which stage do you think you are in right now?\",\n \"question_type\": \"radio\",\n \"answer\": \"Contemplation\"\n },\n {\n \"question_id\": 3,\n \"question\": \"How long do you think you have been in this stage?\",\n \"question_type\": \"radio\",\n \"answer\": \"1 year\"\n },\n {\n \"question_id\": 4,\n \"question\": \"What will be the benefit for you and others as you change your pattern of behavior?\",\n \"question_type\": \"textarea\",\n \"answer\": \"Less consequences in my life, probably happier.\"\n },\n {\n \"question_id\": 5,\n \"question\": \"What individuals, groups, or resources can you turn to for help and support?\",\n \"question_type\": \"textarea\",\n \"answer\": \"My support group and friends.\"\n }\n ]\n }\n\t]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] } ] }, { "name": "Metrics and Analytics", "description": "", "item": [ { "name": "List Company Video Metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/metrics\/videos\/companies\/:companyId", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination. Default: 1:", "disabled": false }, { "key": "limit", "value": "50", "description": "The number of records per page. Default: 50, Max: 100:", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/metrics\/videos\/companies\/:companyId?page=1&limit=50", "variable": [ { "id": "companyId", "key": "companyId", "value": 1, "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 1,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"data\": {\n \"company_id\": \"1342\",\n \"video_metrics\": [\n {\n \"video_log_id\": 1,\n \"video_url\": \"\",\n \"user_id\": 19876,\n \"video_title\": \"Explore the Stages of Change Model\",\n \"start_time_stamp\": \"2024-01-07T21:50:27.000000Z\",\n \"completion_time_stamp\": \"2024-01-07T21:50:53.000000Z\",\n \"watched_percentage\": \"100.00\",\n \"watched_duration\": \"126.92\"\n }\n ]\n }\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List User Video Metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/metrics\/videos\/users\/:userId", "query": [ { "key": "page", "value": "1", "description": "The page number for pagination. Default: 1:", "disabled": false }, { "key": "limit", "value": "50", "description": "The number of records per page. Default: 50, Max: 100:", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/metrics\/videos\/users\/:userId?page=1&limit=50", "variable": [ { "id": "userId", "key": "userId", "value": 1, "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 1,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"per_page\": 50\n },\n \"data\": {\n \"user_id\": \"17434\",\n \"video_metrics\": [\n {\n \"video_log_id\": 3,\n \"video_url\": \"\",\n \"user_id\": 17434,\n \"video_title\": \"Identify My Stage of Change\",\n \"start_time_stamp\": \"2024-01-07T21:56:34.000000Z\",\n \"completion_time_stamp\": \"2024-01-07T21:56:44.000000Z\",\n \"watched_percentage\": \"100.00\",\n \"watched_duration\": \"126.954666\"\n }\n ]\n }\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] } ] }, { "name": "Global Endpoints", "description": "", "item": [ { "name": "List API Endpoints", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/system\/endpoints", "query": [], "raw": "{{baseUrl}}\/api\/v2\/system\/endpoints" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": 0,\n \"message\": \"\",\n \"data\": [\n {\n \"name\": \"List Companies\",\n \"request\": {\n \"url\": {\n \"host\": \"http:\/\/r1discoverapi.local\",\n \"path\": \"api\/v2\/companies\",\n \"query\": [\n {\n \"key\": \"page\",\n \"value\": \"1\",\n \"description\": \"The current page number, defaults to 1.\",\n \"disabled\": false\n },\n {\n \"key\": \"limit\",\n \"value\": \"50\",\n \"description\": \"Number of records to return default 50, max 100.\",\n \"disabled\": false\n }\n ],\n \"raw\": \"http:\/\/r1discoverapi.local\/api\/v2\/companies?page=1&limit=50\"\n },\n \"method\": \"GET\",\n \"header\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application\/json\"\n },\n {\n \"key\": \"Accept\",\n \"value\": \"application\/json\"\n },\n {\n \"key\": \"Authorization\",\n \"value\": \"Bearer {token}\"\n }\n ],\n \"body\": null,\n \"description\": \"\"\n }\n }\n ]\n}", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 403, "body": "{\n \"error\": 1,\n \"message\": \"Unauthorized\",\n \"details\": \"You do not have the necessary permissions to perform this action.\"\n }\n ", "name": "Unauthorized" } ] }, { "name": "List Countries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/system\/countries", "query": [ { "key": "search", "value": "united", "description": "optional Search term to filter countries.", "disabled": false }, { "key": "page", "value": "1", "description": "The current page number, defaults to 1.", "disabled": false }, { "key": "limit", "value": "50", "description": "Number of records to return default 50, max 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/system\/countries?search=united&page=1&limit=50" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"meta\": {\n \"total_items\": 2,\n \"total_pages\": 1,\n \"current_page\": \"1\",\n \"per_page\": \"50\"\n },\n \"country_list\": [\n {\n \"code\": \"GB\",\n \"name\": \"United Kingdom\"\n },\n {\n \"code\": \"US\",\n \"name\": \"United States\"\n }\n ]\n}\n", "name": "Success" }, { "header": [], "code": 401, "body": "{\n \"error\": 1,\n \"message\": \"Unauthenticated\",\n \"details\": \"Authentication is required to access this resource.\"\n }", "name": "Unauthenticated" }, { "header": [], "code": 500, "body": "{\n \"error\": 1,\n \"message\": \"An unexpected error occurred\",\n \"details\": \"The server encountered an unexpected condition that prevented it from fulfilling the request. Please try again later or contact support if the problem persists.\"\n }", "name": "Server Error" } ] } ] } ], "auth": { "type": "noauth" } }