> For the complete documentation index, see [llms.txt](https://docs.mymedtrics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mymedtrics.com/api-reference/medtrics-classic-sis-bridge/groups.md). # Groups ## GET /api/users/groups/ > Legacy /api/users/groups/ bridge resource.\ > \ > Mirrors the \`group\_tags\` precedent for the main group resource.\ > \ > Legacy contract (GroupSerializer fields="\_\_all\_\_" + computed fields):\ > id — integer legacy PK (from etl\_id\_registry.source\_id)\ > name — group name\ > description — optional text\ > portal\_created\_in — 'institution' (no program) or 'administration' (program-scoped)\ > is\_shared — always False (not in Oracle schema)\ > academic\_year — integer legacy PK of academic period, or None\ > programs — \[int legacy\_program\_id] or \[] (Oracle has single program\_id)\ > sites — always \[] (Oracle groups have no site relation)\ > tags — \[int legacy\_tag\_id, ...] (from tag\_legacy\_ids array)\ > view\_access\_to\_users — always False (not in Oracle schema)\ > created\_date — created\_at timestamp\ > updated\_date — updated\_at timestamp\ > display\_name — same as name (Group.\_\_str\_\_ returns self.name)\ > academic\_year\_name — name of the linked academic period, or None\ > leaders — integer count of group\_leaders\ > members — integer count of non-deleted group\_members\ > sites\_data — always \[] (no site relation)\ > tags\_data — \[{id: int, name: str, active: bool}] for assigned tags\ > \ > Connect endpoints:\ > GET /groups → list\ > GET /groups/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > \ > portal\_created\_in heuristic: institution-level groups (program\_id IS NULL) are\ > returned as 'institution'; program-scoped groups (program\_id IS NOT NULL) as\ > 'administration'. This is an approximation — Oracle does not store this field. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ListEnvelope":{"type":"object","description":"Bridge-wide list envelope. count is always null and page_range always [] (cursor pagination upstream).","properties":{"count":{"type":["integer","null"]},"page_range":{"type":"array"},"per_page":{"type":"integer"},"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array"}}},"Groups":{"type":"object","description":"Legacy-shaped users/groups record as served by the bridge; translated from Connect /groups","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}},"paths":{"/api/users/groups/":{"get":{"operationId":"groups_list","tags":["Groups"],"description":"Legacy /api/users/groups/ bridge resource.\n\nMirrors the `group_tags` precedent for the main group resource.\n\nLegacy contract (GroupSerializer fields=\"__all__\" + computed fields):\n id — integer legacy PK (from etl_id_registry.source_id)\n name — group name\n description — optional text\n portal_created_in — 'institution' (no program) or 'administration' (program-scoped)\n is_shared — always False (not in Oracle schema)\n academic_year — integer legacy PK of academic period, or None\n programs — [int legacy_program_id] or [] (Oracle has single program_id)\n sites — always [] (Oracle groups have no site relation)\n tags — [int legacy_tag_id, ...] (from tag_legacy_ids array)\n view_access_to_users — always False (not in Oracle schema)\n created_date — created_at timestamp\n updated_date — updated_at timestamp\n display_name — same as name (Group.__str__ returns self.name)\n academic_year_name — name of the linked academic period, or None\n leaders — integer count of group_leaders\n members — integer count of non-deleted group_members\n sites_data — always [] (no site relation)\n tags_data — [{id: int, name: str, active: bool}] for assigned tags\n\nConnect endpoints:\n GET /groups → list\n GET /groups/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n\nportal_created_in heuristic: institution-level groups (program_id IS NULL) are\nreturned as 'institution'; program-scoped groups (program_id IS NOT NULL) as\n'administration'. This is an approximation — Oracle does not store this field.","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"page_size","in":"query","schema":{"type":"integer","maximum":100}},{"name":"id","in":"query","schema":{"type":"integer"},"description":"maps to Connect legacy_id"},{"name":"name","in":"query","schema":{"type":"integer"},"description":"maps to Connect name"},{"name":"programs","in":"query","schema":{"type":"integer"},"description":"maps to Connect program_legacy_id"},{"name":"academic_year","in":"query","schema":{"type":"integer"},"description":"maps to Connect academic_period_legacy_id"}],"responses":{"200":{"description":"ListEnvelope","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Groups"}}}}]}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## POST /api/users/groups/ > Legacy /api/users/groups/ bridge resource.\ > \ > Mirrors the \`group\_tags\` precedent for the main group resource.\ > \ > Legacy contract (GroupSerializer fields="\_\_all\_\_" + computed fields):\ > id — integer legacy PK (from etl\_id\_registry.source\_id)\ > name — group name\ > description — optional text\ > portal\_created\_in — 'institution' (no program) or 'administration' (program-scoped)\ > is\_shared — always False (not in Oracle schema)\ > academic\_year — integer legacy PK of academic period, or None\ > programs — \[int legacy\_program\_id] or \[] (Oracle has single program\_id)\ > sites — always \[] (Oracle groups have no site relation)\ > tags — \[int legacy\_tag\_id, ...] (from tag\_legacy\_ids array)\ > view\_access\_to\_users — always False (not in Oracle schema)\ > created\_date — created\_at timestamp\ > updated\_date — updated\_at timestamp\ > display\_name — same as name (Group.\_\_str\_\_ returns self.name)\ > academic\_year\_name — name of the linked academic period, or None\ > leaders — integer count of group\_leaders\ > members — integer count of non-deleted group\_members\ > sites\_data — always \[] (no site relation)\ > tags\_data — \[{id: int, name: str, active: bool}] for assigned tags\ > \ > Connect endpoints:\ > GET /groups → list\ > GET /groups/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > \ > portal\_created\_in heuristic: institution-level groups (program\_id IS NULL) are\ > returned as 'institution'; program-scoped groups (program\_id IS NOT NULL) as\ > 'administration'. This is an approximation — Oracle does not store this field. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Groups":{"type":"object","description":"Legacy-shaped users/groups record as served by the bridge; translated from Connect /groups","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}},"paths":{"/api/users/groups/":{"post":{"operationId":"groups_create","tags":["Groups"],"description":"Legacy /api/users/groups/ bridge resource.\n\nMirrors the `group_tags` precedent for the main group resource.\n\nLegacy contract (GroupSerializer fields=\"__all__\" + computed fields):\n id — integer legacy PK (from etl_id_registry.source_id)\n name — group name\n description — optional text\n portal_created_in — 'institution' (no program) or 'administration' (program-scoped)\n is_shared — always False (not in Oracle schema)\n academic_year — integer legacy PK of academic period, or None\n programs — [int legacy_program_id] or [] (Oracle has single program_id)\n sites — always [] (Oracle groups have no site relation)\n tags — [int legacy_tag_id, ...] (from tag_legacy_ids array)\n view_access_to_users — always False (not in Oracle schema)\n created_date — created_at timestamp\n updated_date — updated_at timestamp\n display_name — same as name (Group.__str__ returns self.name)\n academic_year_name — name of the linked academic period, or None\n leaders — integer count of group_leaders\n members — integer count of non-deleted group_members\n sites_data — always [] (no site relation)\n tags_data — [{id: int, name: str, active: bool}] for assigned tags\n\nConnect endpoints:\n GET /groups → list\n GET /groups/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n\nportal_created_in heuristic: institution-level groups (program_id IS NULL) are\nreturned as 'institution'; program-scoped groups (program_id IS NOT NULL) as\n'administration'. This is an approximation — Oracle does not store this field.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## GET /api/users/groups/{id}/ > Legacy /api/users/groups/ bridge resource.\ > \ > Mirrors the \`group\_tags\` precedent for the main group resource.\ > \ > Legacy contract (GroupSerializer fields="\_\_all\_\_" + computed fields):\ > id — integer legacy PK (from etl\_id\_registry.source\_id)\ > name — group name\ > description — optional text\ > portal\_created\_in — 'institution' (no program) or 'administration' (program-scoped)\ > is\_shared — always False (not in Oracle schema)\ > academic\_year — integer legacy PK of academic period, or None\ > programs — \[int legacy\_program\_id] or \[] (Oracle has single program\_id)\ > sites — always \[] (Oracle groups have no site relation)\ > tags — \[int legacy\_tag\_id, ...] (from tag\_legacy\_ids array)\ > view\_access\_to\_users — always False (not in Oracle schema)\ > created\_date — created\_at timestamp\ > updated\_date — updated\_at timestamp\ > display\_name — same as name (Group.\_\_str\_\_ returns self.name)\ > academic\_year\_name — name of the linked academic period, or None\ > leaders — integer count of group\_leaders\ > members — integer count of non-deleted group\_members\ > sites\_data — always \[] (no site relation)\ > tags\_data — \[{id: int, name: str, active: bool}] for assigned tags\ > \ > Connect endpoints:\ > GET /groups → list\ > GET /groups/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > \ > portal\_created\_in heuristic: institution-level groups (program\_id IS NULL) are\ > returned as 'institution'; program-scoped groups (program\_id IS NOT NULL) as\ > 'administration'. This is an approximation — Oracle does not store this field. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Groups":{"type":"object","description":"Legacy-shaped users/groups record as served by the bridge; translated from Connect /groups","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}},"paths":{"/api/users/groups/{id}/":{"get":{"operationId":"groups_retrieve","tags":["Groups"],"description":"Legacy /api/users/groups/ bridge resource.\n\nMirrors the `group_tags` precedent for the main group resource.\n\nLegacy contract (GroupSerializer fields=\"__all__\" + computed fields):\n id — integer legacy PK (from etl_id_registry.source_id)\n name — group name\n description — optional text\n portal_created_in — 'institution' (no program) or 'administration' (program-scoped)\n is_shared — always False (not in Oracle schema)\n academic_year — integer legacy PK of academic period, or None\n programs — [int legacy_program_id] or [] (Oracle has single program_id)\n sites — always [] (Oracle groups have no site relation)\n tags — [int legacy_tag_id, ...] (from tag_legacy_ids array)\n view_access_to_users — always False (not in Oracle schema)\n created_date — created_at timestamp\n updated_date — updated_at timestamp\n display_name — same as name (Group.__str__ returns self.name)\n academic_year_name — name of the linked academic period, or None\n leaders — integer count of group_leaders\n members — integer count of non-deleted group_members\n sites_data — always [] (no site relation)\n tags_data — [{id: int, name: str, active: bool}] for assigned tags\n\nConnect endpoints:\n GET /groups → list\n GET /groups/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n\nportal_created_in heuristic: institution-level groups (program_id IS NULL) are\nreturned as 'institution'; program-scoped groups (program_id IS NOT NULL) as\n'administration'. This is an approximation — Oracle does not store this field.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PUT /api/users/groups/{id}/ > Legacy /api/users/groups/ bridge resource.\ > \ > Mirrors the \`group\_tags\` precedent for the main group resource.\ > \ > Legacy contract (GroupSerializer fields="\_\_all\_\_" + computed fields):\ > id — integer legacy PK (from etl\_id\_registry.source\_id)\ > name — group name\ > description — optional text\ > portal\_created\_in — 'institution' (no program) or 'administration' (program-scoped)\ > is\_shared — always False (not in Oracle schema)\ > academic\_year — integer legacy PK of academic period, or None\ > programs — \[int legacy\_program\_id] or \[] (Oracle has single program\_id)\ > sites — always \[] (Oracle groups have no site relation)\ > tags — \[int legacy\_tag\_id, ...] (from tag\_legacy\_ids array)\ > view\_access\_to\_users — always False (not in Oracle schema)\ > created\_date — created\_at timestamp\ > updated\_date — updated\_at timestamp\ > display\_name — same as name (Group.\_\_str\_\_ returns self.name)\ > academic\_year\_name — name of the linked academic period, or None\ > leaders — integer count of group\_leaders\ > members — integer count of non-deleted group\_members\ > sites\_data — always \[] (no site relation)\ > tags\_data — \[{id: int, name: str, active: bool}] for assigned tags\ > \ > Connect endpoints:\ > GET /groups → list\ > GET /groups/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > \ > portal\_created\_in heuristic: institution-level groups (program\_id IS NULL) are\ > returned as 'institution'; program-scoped groups (program\_id IS NOT NULL) as\ > 'administration'. This is an approximation — Oracle does not store this field. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Groups":{"type":"object","description":"Legacy-shaped users/groups record as served by the bridge; translated from Connect /groups","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}},"paths":{"/api/users/groups/{id}/":{"put":{"operationId":"groups_update","tags":["Groups"],"description":"Legacy /api/users/groups/ bridge resource.\n\nMirrors the `group_tags` precedent for the main group resource.\n\nLegacy contract (GroupSerializer fields=\"__all__\" + computed fields):\n id — integer legacy PK (from etl_id_registry.source_id)\n name — group name\n description — optional text\n portal_created_in — 'institution' (no program) or 'administration' (program-scoped)\n is_shared — always False (not in Oracle schema)\n academic_year — integer legacy PK of academic period, or None\n programs — [int legacy_program_id] or [] (Oracle has single program_id)\n sites — always [] (Oracle groups have no site relation)\n tags — [int legacy_tag_id, ...] (from tag_legacy_ids array)\n view_access_to_users — always False (not in Oracle schema)\n created_date — created_at timestamp\n updated_date — updated_at timestamp\n display_name — same as name (Group.__str__ returns self.name)\n academic_year_name — name of the linked academic period, or None\n leaders — integer count of group_leaders\n members — integer count of non-deleted group_members\n sites_data — always [] (no site relation)\n tags_data — [{id: int, name: str, active: bool}] for assigned tags\n\nConnect endpoints:\n GET /groups → list\n GET /groups/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n\nportal_created_in heuristic: institution-level groups (program_id IS NULL) are\nreturned as 'institution'; program-scoped groups (program_id IS NOT NULL) as\n'administration'. This is an approximation — Oracle does not store this field.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## DELETE /api/users/groups/{id}/ > Legacy /api/users/groups/ bridge resource.\ > \ > Mirrors the \`group\_tags\` precedent for the main group resource.\ > \ > Legacy contract (GroupSerializer fields="\_\_all\_\_" + computed fields):\ > id — integer legacy PK (from etl\_id\_registry.source\_id)\ > name — group name\ > description — optional text\ > portal\_created\_in — 'institution' (no program) or 'administration' (program-scoped)\ > is\_shared — always False (not in Oracle schema)\ > academic\_year — integer legacy PK of academic period, or None\ > programs — \[int legacy\_program\_id] or \[] (Oracle has single program\_id)\ > sites — always \[] (Oracle groups have no site relation)\ > tags — \[int legacy\_tag\_id, ...] (from tag\_legacy\_ids array)\ > view\_access\_to\_users — always False (not in Oracle schema)\ > created\_date — created\_at timestamp\ > updated\_date — updated\_at timestamp\ > display\_name — same as name (Group.\_\_str\_\_ returns self.name)\ > academic\_year\_name — name of the linked academic period, or None\ > leaders — integer count of group\_leaders\ > members — integer count of non-deleted group\_members\ > sites\_data — always \[] (no site relation)\ > tags\_data — \[{id: int, name: str, active: bool}] for assigned tags\ > \ > Connect endpoints:\ > GET /groups → list\ > GET /groups/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > \ > portal\_created\_in heuristic: institution-level groups (program\_id IS NULL) are\ > returned as 'institution'; program-scoped groups (program\_id IS NOT NULL) as\ > 'administration'. This is an approximation — Oracle does not store this field. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Groups":{"type":"object","description":"Legacy-shaped users/groups record as served by the bridge; translated from Connect /groups","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}},"paths":{"/api/users/groups/{id}/":{"delete":{"operationId":"groups_destroy","tags":["Groups"],"description":"Legacy /api/users/groups/ bridge resource.\n\nMirrors the `group_tags` precedent for the main group resource.\n\nLegacy contract (GroupSerializer fields=\"__all__\" + computed fields):\n id — integer legacy PK (from etl_id_registry.source_id)\n name — group name\n description — optional text\n portal_created_in — 'institution' (no program) or 'administration' (program-scoped)\n is_shared — always False (not in Oracle schema)\n academic_year — integer legacy PK of academic period, or None\n programs — [int legacy_program_id] or [] (Oracle has single program_id)\n sites — always [] (Oracle groups have no site relation)\n tags — [int legacy_tag_id, ...] (from tag_legacy_ids array)\n view_access_to_users — always False (not in Oracle schema)\n created_date — created_at timestamp\n updated_date — updated_at timestamp\n display_name — same as name (Group.__str__ returns self.name)\n academic_year_name — name of the linked academic period, or None\n leaders — integer count of group_leaders\n members — integer count of non-deleted group_members\n sites_data — always [] (no site relation)\n tags_data — [{id: int, name: str, active: bool}] for assigned tags\n\nConnect endpoints:\n GET /groups → list\n GET /groups/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n\nportal_created_in heuristic: institution-level groups (program_id IS NULL) are\nreturned as 'institution'; program-scoped groups (program_id IS NOT NULL) as\n'administration'. This is an approximation — Oracle does not store this field.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PATCH /api/users/groups/{id}/ > Legacy /api/users/groups/ bridge resource.\ > \ > Mirrors the \`group\_tags\` precedent for the main group resource.\ > \ > Legacy contract (GroupSerializer fields="\_\_all\_\_" + computed fields):\ > id — integer legacy PK (from etl\_id\_registry.source\_id)\ > name — group name\ > description — optional text\ > portal\_created\_in — 'institution' (no program) or 'administration' (program-scoped)\ > is\_shared — always False (not in Oracle schema)\ > academic\_year — integer legacy PK of academic period, or None\ > programs — \[int legacy\_program\_id] or \[] (Oracle has single program\_id)\ > sites — always \[] (Oracle groups have no site relation)\ > tags — \[int legacy\_tag\_id, ...] (from tag\_legacy\_ids array)\ > view\_access\_to\_users — always False (not in Oracle schema)\ > created\_date — created\_at timestamp\ > updated\_date — updated\_at timestamp\ > display\_name — same as name (Group.\_\_str\_\_ returns self.name)\ > academic\_year\_name — name of the linked academic period, or None\ > leaders — integer count of group\_leaders\ > members — integer count of non-deleted group\_members\ > sites\_data — always \[] (no site relation)\ > tags\_data — \[{id: int, name: str, active: bool}] for assigned tags\ > \ > Connect endpoints:\ > GET /groups → list\ > GET /groups/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > \ > portal\_created\_in heuristic: institution-level groups (program\_id IS NULL) are\ > returned as 'institution'; program-scoped groups (program\_id IS NOT NULL) as\ > 'administration'. This is an approximation — Oracle does not store this field. ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Groups":{"type":"object","description":"Legacy-shaped users/groups record as served by the bridge; translated from Connect /groups","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}},"paths":{"/api/users/groups/{id}/":{"patch":{"operationId":"groups_partial_update","tags":["Groups"],"description":"Legacy /api/users/groups/ bridge resource.\n\nMirrors the `group_tags` precedent for the main group resource.\n\nLegacy contract (GroupSerializer fields=\"__all__\" + computed fields):\n id — integer legacy PK (from etl_id_registry.source_id)\n name — group name\n description — optional text\n portal_created_in — 'institution' (no program) or 'administration' (program-scoped)\n is_shared — always False (not in Oracle schema)\n academic_year — integer legacy PK of academic period, or None\n programs — [int legacy_program_id] or [] (Oracle has single program_id)\n sites — always [] (Oracle groups have no site relation)\n tags — [int legacy_tag_id, ...] (from tag_legacy_ids array)\n view_access_to_users — always False (not in Oracle schema)\n created_date — created_at timestamp\n updated_date — updated_at timestamp\n display_name — same as name (Group.__str__ returns self.name)\n academic_year_name — name of the linked academic period, or None\n leaders — integer count of group_leaders\n members — integer count of non-deleted group_members\n sites_data — always [] (no site relation)\n tags_data — [{id: int, name: str, active: bool}] for assigned tags\n\nConnect endpoints:\n GET /groups → list\n GET /groups/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n\nportal_created_in heuristic: institution-level groups (program_id IS NULL) are\nreturned as 'institution'; program-scoped groups (program_id IS NOT NULL) as\n'administration'. This is an approximation — Oracle does not store this field.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"description":{"type":"string","description":"Connect description"},"members":{"type":"string","description":"Connect member_count"},"leaders":{"type":"string","description":"Connect leader_count"},"academic_year_name":{"type":"string","description":"Connect academic_period_name"},"created_date":{"type":"string","description":"Connect created_at"},"updated_date":{"type":"string","description":"Connect updated_at"},"is_shared":{"type":"string","description":"literal False"},"view_access_to_users":{"type":"string","description":"literal False"},"sites":{"type":"string","description":"literal []"},"sites_data":{"type":"string","description":"literal []"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.mymedtrics.com/api-reference/medtrics-classic-sis-bridge/groups.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.