API Reference / Workspaces
List the caller's workspaces
Returns every workspace the caller holds an accepted membership in, regardless of which workspace is currently active. There is no workspace_id or user_id request field. The result always means the caller's own workspaces.
/ accounts. v1. Accounts/ ListWorkspacesRequest body
application/jsonRequired
Request for one page of every workspace the caller has an accepted membership in, whichever workspace is current.
cursor?stringOpaque pagination cursor from a previous ListWorkspacesResponse's next_cursor. The client must not parse or construct one. Empty for the first page. An empty next_cursor on the response signals the last page.
descending?booleanOrder descending instead of ascending.
filter?WorkspaceFilterOptional filters applied before pagination. Keep unchanged when continuing with a cursor.
Show attributes
query?stringOptional case-insensitive literal substring of the workspace name, matched server side. Administrator reads also match the owner's name and email. Absent or empty matches every workspace.
stops?array<string>Administrator reads only. Matches a workspace in any of the listed stop states, read from the stops contracts records. Empty does not restrict.
Value in"WORKSPACE_"WORKSPACE_"WORKSPACE_"WORKSPACE_"WORKSPACE_
limit?integerMaximum number of workspaces to return. Server caps this at a service-defined upper bound.
Format"int32"
sortField?stringField to order the page by. Unspecified orders by creation time.
Value in"WORKSPACE_"WORKSPACE_"WORKSPACE_
Response body
application/json
Success
memberships?array<Membership>The caller's own accepted membership in each workspace on the page, one per workspace, matched by workspace_id. Carries the caller's role and policies there.
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.
workspaces?array<Workspace>The workspaces on this page, in the requested order, each with its member count.
Show attributes
createdAt?stringWhen the workspace was created.
Format"date-time"
deletedAt?stringWhen the workspace was soft-deleted. Unset for active workspaces.
Format"date-time"
description?stringFree-form workspace description set by the workspace owner.
getStartedCompletedAt?stringWhen the workspace completed Get started: the first time it had proxies, accounts, a connected market and a contract all at once. Unset until then. Once set it is never cleared.
Format"date-time"
hardDeleteAt?stringWhen a soft-deleted workspace and everything in it is removed permanently. Unset for active workspaces.
Format"date-time"
id?stringOpaque 16-byte workspace identifier, base64-encoded in JSON.
Format"byte" base64
memberCount?integerNumber of accepted memberships in the workspace, computed server-side at read time. Read-only: any value sent by a client is ignored.
Format"int32"
name?stringHuman-readable workspace name.
owner?ActorSummaryThe workspace owner resolved for display at read time. Set only on administrator reads. Unset when the workspace has no accepted owner.
Show attributes
avatarUrl?stringThe user's avatar image URL. Unset for an API key or a user with no avatar.
displayName?stringThe user's name or the API key's name at read time. Empty when the actor no longer exists.
id?stringOpaque 16-byte identifier of the user or API key, base64-encoded in JSON.
Format"byte" base64
subjectType?stringHow the actor authenticated: a user session or an API key.
Value in"SUBJECT_"SUBJECT_"SUBJECT_
ownerEmail?stringThe workspace owner's email. Set only on administrator reads.
updatedAt?stringWhen the workspace was last modified.
Format"date-time"
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/ListWorkspaces" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/ListWorkspaces", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const data = await res.json();body := strings.NewReader(`{}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/ListWorkspaces", 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/ListWorkspaces",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={},
)
data = res.json(){
"workspaces": [
{
"id": "AAECAwQFBgcICQoLDA0ODw==",
"name": "Acme Trading",
"description": "Primary trading workspace.",
"createdAt": "2026-01-15T10:00:00Z",
"updatedAt": "2026-03-02T14:22:30Z"
},
{
"id": "9HrBC1jMQ3KlZw4CssPUeQ==",
"name": "Redline Flips",
"createdAt": "2026-06-29T12:00:00Z",
"updatedAt": "2026-06-29T12:00:00Z"
}
]
}{
"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."
}