Retrieve Group Members

CUSTOM-ENDPOINT

GET https://api.speakap.io/networks/:eid/memberships/?group=:eid

CUSTOM-AUTHORIZATION

Permissions: list_group_members

CUSTOM-REQUEST

URI: /networks/{networkEID}/memberships/?group={groupEID}
Method: GET
Accept: application/vnd.speakap.api-v1.8.2+json+hal
Authentication: OAuth 2.0

Parameters

Name	Type	Description
networkEID	EID	Network EID
groupEID	EID	Group EID

Filters

Name	Type	Description
q	string	Filters users whose full names or job titles match the specified terms

Response

Status	Data
200	Returns a collection of Membership resources
403	Unauthorized: returns an Error object
404	Unknown network or group: returns an Error object
410	Deleted group: returns an Error object

Example (with embedding)

{
    "_links": {
        "self": {
            "href": "/networks/fedcba0987654321/users/?group=1234567890abcdef"
        },
        "networkMemberships": {
            "href": "/networks/fedcba0987654321/memberships/"
        }
    },
    "_embedded": {
        "groupMemberships": [
            {
                "_links": {
                    "self": {
                        "href": "/networks/fedcba0987654321/memberships/abcdef0123456789/"
                    }
                },
                "_embedded": {
                    "user": {
                        "_links": {
                            "self": {
                                "href": "/networks/fedcba0987654321/users/abcdef0123456789/"
                            }
                        },
                        "fullName": "John Smith",
                    }
                },
                "role": "member",
                "since": "2013-04-11T17:40:21.123+01:00"
            },
            {
                "_links": {
                    "self": {
                        "href": "/networks/fedcba0987654321/memberships/0123456789fedcba/"
                    }
                },
                "_embedded": {
                    "user": {
                        "_links": {
                            "self": {
                                "href": "/networks/fedcba0987654321/users/0123456789fedcba/"
                            }
                        },
                        "fullName": "Jane Doe"
                    }
                },
                "role": "member",
                "since": "2013-04-11T13:35:07.123+01:00"
            }
        ]
    }
}