Space Members | Documentation

Group Space Members

An individual user in your organization can be given access to a space directly, via a space membership, or indirectly, via their membership in a team that has itself been granted access via a team space membership. The access rights of a user in a space are calculated by combining the rights of all such memberships through which the user has derived access.

Because this complex relationship between a user and a space can be difficult to reason about, the space member entity was developed. This entity reveals exactly which individual users have access to a space, and reveals their combined access rights within a single object. Furthermore, it provides a link to the related membership objects from which their access is derived.

Get all space members in a space

This endpoint returns a paginated collection of all the space members in a space. This collection represents the set of all users in your organization who have access to the space.

All space members can access this endpoint.

Query Parameters

Name	Details	Description
`skip`, `limit`	-	Specify requested page of result set. See Pagination for more details.
`include`	Supported values: `sys.user`	Specify linked resources to include in response. See Including Related Resources for more details.

For the following response, the SpaceMember resources returned in items are the same for all requesters.

When using include=sys.user, the included User resources may differ depending on the requester’s role in the space:

Admin requesters may receive full user information in includes.User.
Non-admin requesters may receive a reduced (minified) representation in includes.User.

Response

1 {
2     "total": 1,
3     "limit": 25,
4     "skip": 0,
5     "sys": {
6         "type": "Array"
7     },
8     "items": [
9         {
10             "sys": {
11                 "type": "SpaceMember",
12                 "id": "jn066pnp3hgr-7uqvFPPLzgtVaezGvjA9U6",
13                 "version": 1,
14                 "createdAt": "2013-04-11T20:04:37Z",
15                 "updatedAt": "2014-05-11T20:04:37Z",
16                 "space": {
17                     "sys": {
18                         "type": "Link",
19                         "linkType": "Space",
20                         "id": "jn066pnp3hgr"
21                     }
22                 },
23                 "user": {
24                     "sys": {
25                         "type": "Link",
26                         "linkType": "User",
27                         "id": "7uqvFPPLzgtVaezGvjA9U6"
28                     }
29                 },
30                 "relatedMemberships": [
31                     {
32                         "sys": {
33                             "type": "Link",
34                             "linkType": "SpaceMembership",
35                             "id": "2G3gCn1mi1UHSBLTP2v4TI"
36                         }
37                     },
38                     {
39                         "sys": {
40                             "type": "Link",
41                             "linkType": "TeamSpaceMembership",
42                             "id": "4FG3gCn1mi1UHSBLTP2v3GB"
43                         }
44                     }
45                 ]
46             },
47             "admin": false,
48             "roles": [
49                 {
50                     "sys": {
51                         "type": "Link",
52                         "linkType": "Role",
53                         "id": "1ElgCn1mi1UHSBLTP2v4TD"
54                     }
55                 }
56             ]
57         }
58     ]
59 }

When include=sys.user is specified, clients should not assume that all user attributes are always present in includes.User. The shape of included user data depends on the caller’s role in the space.

Get a single space member

This endpoint returns the details of a space member.

Response

1 {
2     "sys": {
3         "type": "SpaceMember",
4         "id": "jn066pnp3hgr-7uqvFPPLzgtVaezGvjA9U6",
5         "version": 1,
6         "createdAt": "2013-04-11T20:04:37Z",
7         "updatedAt": "2014-05-11T20:04:37Z",
8         "space": {
9             "sys": {
10                 "type": "Link",
11                 "linkType": "Space",
12                 "id": "jn066pnp3hgr"
13             }
14         },
15         "user": {
16             "sys": {
17                 "type": "Link",
18                 "linkType": "User",
19                 "id": "7uqvFPPLzgtVaezGvjA9U6"
20             }
21         },
22         "relatedMemberships": [
23             {
24                 "sys": {
25                     "type": "Link",
26                     "linkType": "SpaceMembership",
27                     "id": "2G3gCn1mi1UHSBLTP2v4TI"
28                 }
29             },
30             {
31                 "sys": {
32                     "type": "Link",
33                     "linkType": "TeamSpaceMembership",
34                     "id": "4FG3gCn1mi1UHSBLTP2v3GB"
35                 }
36             }
37         ]
38     },
39     "admin": false,
40     "roles": [
41         {
42             "sys": {
43                 "type": "Link",
44                 "linkType": "Role",
45                 "id": "1ElgCn1mi1UHSBLTP2v4TD"
46             }
47         }
48     ]
49 }