API Reference / Memberships
List memberships in the caller's own workspace
Lists memberships in the caller's own active workspace, optionally narrowed to a single user. There is no workspace_id request field. The result always means the caller's own workspace. Results are paginated. Pass the returned cursor to fetch the next page.
/ accounts. v1. Accounts/ ListMembershipsRequest body
application/jsonRequired
Request for one page of the memberships in the caller's workspace, optionally narrowed by user and status.
cursor?stringOpaque cursor from a previous ListMembershipsResponse.next_cursor. Empty for the first page. Send the same filter with every page.
descending?booleanTrue orders the page descending. False orders it ascending.
filter?MembershipFilterOptional filters applied before pagination.
Show attributes
query?stringOptional case-insensitive literal substring of the member's display name or email, matched server side. Absent or empty matches every membership.
userId?stringOptional filter: only memberships for this user.
Format"byte" base64
limit?integerMaximum number of memberships to return, up to 100. Zero uses the default of 100. A larger value is rejected with invalid_argument.
Format"int32"
sortField?stringField to order the page by, creation time or last update time. Unspecified orders by creation time.
Value in"MEMBERSHIP_"MEMBERSHIP_"MEMBERSHIP_
statuses?array<string>Optional status set, the grouping dimension CountMemberships breaks down by. Empty includes every status.
Value in"MEMBERSHIP_"MEMBERSHIP_
Response body
application/json
Success
memberships?array<Membership>The memberships on this page, in the requested order.
Show attributes
createdAt?stringWhen the membership was created, which for a member is when they were invited.
Format"date-time"
expiresAt?stringWhen a pending invitation stops being acceptable. Unset once accepted and for an owner.
Format"date-time"
id?stringOpaque 16-byte identifier of the membership, assigned when the invitation is created. Base64-encoded in JSON.
Format"byte" base64
invitedBy?stringOpaque 16-byte identifier of the user who sent the invitation. Unset for the workspace owner and for invitations sent before the inviter was recorded.
Format"byte" base64
lastActiveAt?stringWhen the member last used the workspace while signed in, to the minute. Unset for a member who has not used it since activity was recorded.
Format"date-time"
policies?array<string>Names of the policies a member holds: any of "trading", "steam", "proxies", "analytics" and "csfloat". Empty means a read-only member. Not used for an owner or an administrator, who hold every operational permission by role.
role?stringOwner for the one person who holds the workspace (its creator until ownership is transferred), administrator for someone who runs it with the owner but cannot delete it, hand it over or change roles, or member for everyone else.
Value in"MEMBERSHIP_"MEMBERSHIP_"MEMBERSHIP_
status?stringInvited until the invited user accepts, then accepted.
Value in"MEMBERSHIP_"MEMBERSHIP_
updatedAt?stringWhen the membership was last changed, such as accepted or given new policies.
Format"date-time"
userId?stringOpaque 16-byte identifier of the member user, base64-encoded in JSON.
Format"byte" base64
workspaceId?stringOpaque 16-byte identifier of the workspace, base64-encoded in JSON.
Format"byte" base64
nextCursor?stringCursor to pass as cursor to fetch the next page. Empty when this is the last page.
application/json
The request was malformed, such as a missing required field or an unparseable cursor.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/ListMemberships" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"limit": 50
}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/ListMemberships", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 50
}),
});
const data = await res.json();body := strings.NewReader(`{
"limit": 50
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/ListMemberships", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/accounts.v1.Accounts/ListMemberships",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"limit": 50
},
)
data = res.json(){
"membershipIds": [
"VniQq83vEjRWeBI0VniQqw==",
"ICEiIyQlJicoKSorLC0uLw=="
],
"nextCursor": "eyJvZmZzZXQiOjUwfQ=="
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}