GET /spaces/{spaceId}/members

This API returns an array of members of a space by given the space id. Members include admin, member, guest. For query pagination, please use the nextPageUrl and previousPageUrl from the response data. Note: page and size parameters were previously ignored, they are now recognized.

URL Parameters

NameDescriptionLocationRequiredDefault Value
spaceIdThe ID of the spacePathYes
sizeThe number of messages in the response dataQueryNo30
pageThe page number of the response dataQueryNo0
searchThe search string to filter membersQueryNo

Body Parameters

None.

Authentication

JwtAuthenticator, Oauth2Authenticator, AnonymousAuthenticator4001

Authorization

PERM_TOPIC_READ

Example Request

URL

For Production: GET https://spacesapis.avayacloud.com/api/spaces/{spaceId}/members
For Staging: GET https://loganstagingapis.esna.com/api/spaces/{spaceId}/members

Headers

Authorization: "jwt eyJhbGciOiJSUzI1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Example Response

{
    "data": [
        {
            "phone_numbers": [],
            "member": "5eeb4e49aa4a347af9c7b...",
            "memberType": "userId",
            "role": "admin",
            "joinTime": "2020-07-07T17:14:17.114Z",
            "username": "user1@avaya.com",
            "displayname": "Username1",
            "picture_url": "https://storage.googleapis.com/onesna/pictures/pfpic_85c55d13-6f87-42f4-a576-c1a5a87dc..."
        }
    ],
    "total": 1
}