|
| 1 | +# Group Membership API- Scripted REST API |
| 2 | +## Overview |
| 3 | +This API provides a simple, secure way to reterive all members of a specified user group in ServiceNow. It allows integrations, Service Portal widgets, or external systems to query group membership without giving direct access to user tables |
| 4 | + |
| 5 | +### API Details |
| 6 | +- **API Name**: Group Membership API |
| 7 | +- **API ID**: group_membership_api |
| 8 | +- **ResourceName**: Members |
| 9 | +- **Relative Path**: /members |
| 10 | +- **HTTP Method**: GET |
| 11 | +- **Query Parameter**: groupName (required) |
| 12 | + |
| 13 | +## Request Format |
| 14 | + |
| 15 | +### Example Request |
| 16 | +GET https://<instance>.service-now.com/api/1819147/group_membership_api/members?groupName=Hardware |
| 17 | + |
| 18 | +### Example Response |
| 19 | +```json |
| 20 | +{ |
| 21 | + { |
| 22 | + "result": { |
| 23 | + "groupName": "Hardware", |
| 24 | + "totalMembers": 7, |
| 25 | + "member": [ |
| 26 | + { |
| 27 | + "userName": "beth.anglin", |
| 28 | + "displayName": "Beth Anglin", |
| 29 | + "email": "beth.anglin@example.com", |
| 30 | + "active": "true" |
| 31 | + }, |
| 32 | + { |
| 33 | + "userName": "itil", |
| 34 | + "displayName": "ITIL User", |
| 35 | + "email": "itil@example.com", |
| 36 | + "active": "true" |
| 37 | + }, |
| 38 | + { |
| 39 | + "userName": "bow.ruggeri", |
| 40 | + "displayName": "Bow Ruggeri", |
| 41 | + "email": "bow.ruggeri@example.com", |
| 42 | + "active": "true" |
| 43 | + }, |
| 44 | + { |
| 45 | + "userName": "david.dan", |
| 46 | + "displayName": "David Dan", |
| 47 | + "email": "david.dan@example.com", |
| 48 | + "active": "true" |
| 49 | + }, |
| 50 | + { |
| 51 | + "userName": "david.loo", |
| 52 | + "displayName": "David Loo", |
| 53 | + "email": "david.loo@example.com", |
| 54 | + "active": "true" |
| 55 | + }, |
| 56 | + { |
| 57 | + "userName": "don.goodliffe", |
| 58 | + "displayName": "Don Goodliffe", |
| 59 | + "email": "don.goodliffe@example.com", |
| 60 | + "active": "true" |
| 61 | + }, |
| 62 | + { |
| 63 | + "userName": "fred.luddy", |
| 64 | + "displayName": "Fred Luddy", |
| 65 | + "email": "fred.luddy@example.com", |
| 66 | + "active": "true" |
| 67 | + } |
| 68 | + ] |
| 69 | + } |
| 70 | +} |
| 71 | + |
| 72 | +} |
0 commit comments