{ "opencollection": "1.0.0", "info": { "name": "Skilljar Assets Groups API", "version": "1.0.0" }, "items": [ { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "groups_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/groups", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter groups by exact match on group name" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all groups in your organization.\n\nReturns a paginated list of groups. You can filter by exact group name using the `name` query parameter." }, { "info": { "name": "groups_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a new group.\n\nGroups can be configured with optional sign-up field rules to automate user assignment." }, { "info": { "name": "groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve details for a specific group.\n\nReturns group information including name, discount, user count, and sign-up field rules." }, { "info": { "name": "groups_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update group details.\n\nBoth PUT and PATCH requests perform partial updates. You can modify group name, discount,\n or sign-up field rules." }, { "info": { "name": "groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update group details.\n\nBoth PUT and PATCH requests perform partial updates. You can modify group name, discount,\n or sign-up field rules." }, { "info": { "name": "groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a group.\n\nPermanently removes the group and all group-user associations. Users and domain users are not deleted.\nThis operation cannot be undone." } ] } ], "bundled": true }