Skip to content

API Reference / Memberships

List the caller's pending workspace invitations

Lists the invitations addressed to the caller that have not been accepted or declined, whichever workspace is current, each with the workspace's name and member count and who sent it. There is no user_id request field. The result always means the caller's own invitations.

POST/accounts.v1.Accounts/ListMyInvitations

Request body

application/jsonRequired

Request for one page of the caller's own pending workspace invitations, oldest first.

cursor?string

Opaque cursor from a previous ListMyInvitationsResponse.next_cursor. Empty for the first page.

filter?InvitationFilter

Optional filters applied before pagination. Keep unchanged when continuing with a cursor.

Show attributes
membershipIds?array<string>

Only these invited memberships, OR within the field, so an invitation page reads its one invitation. At most 100. Empty includes every pending invitation of the caller.

limit?integer

Maximum number of invitations to return, up to 100. Zero uses the default of 100. A larger value is rejected with invalid_argument.

Format"int32"

Response body

application/json

Success

invitations?array<InvitationSummary>

The invitations on this page, ordered by creation time then id.

Show attributes
createdAt?string

When the invitation was sent.

Format"date-time"

expiresAt?string

When the invitation stops being acceptable. An invitation past this time is still listed so the page can say it expired.

Format"date-time"

inviter?ActorSummary

Who sent the invitation. Unset for invitations sent before the inviter was recorded.

Show attributes
avatarUrl?string

The user's avatar image URL. Unset for an API key or a user with no avatar.

displayName?string

The user's name or the API key's name at read time. Empty when the actor no longer exists.

id?string

Opaque 16-byte identifier of the user or API key, base64-encoded in JSON.

Format"byte" base64

subjectType?string

How the actor authenticated: a user session or an API key.

Value in"SUBJECT_TYPE_SESSION""SUBJECT_TYPE_API_KEY""SUBJECT_TYPE_SERVICE"

membershipId?string

Opaque 16-byte identifier of the invited membership, the id AcceptMembership and DeclineMembership take.

Format"byte" base64

policies?array<string>

The policies the invitation grants, as on Membership.policies. Empty means a read-only member.

role?string

The role the invitation offers.

Value in"MEMBERSHIP_ROLE_OWNER""MEMBERSHIP_ROLE_MEMBER""MEMBERSHIP_ROLE_ADMINISTRATOR"

workspaceId?string

Opaque 16-byte identifier of the inviting workspace.

Format"byte" base64

workspaceMemberCount?integer

Number of accepted memberships in the workspace at read time, not counting this invitation.

Format"int32"

workspaceName?string

The workspace's name at read time.

nextCursor?string

Cursor to pass as cursor to fetch the next page. Empty when this is the last page.

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/ListMyInvitations" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "invitations": [
    {
      "membershipId": "VniQq83vEjRWeBI0VniQqw==",
      "workspaceId": "AAECAwQFBgcICQoLDA0ODw==",
      "workspaceName": "Northwind Flips",
      "workspaceMemberCount": 4,
      "role": "MEMBERSHIP_ROLE_MEMBER",
      "policies": [
        "trading"
      ],
      "inviter": {
        "subjectType": "SUBJECT_TYPE_SESSION",
        "id": "ICEiIyQlJicoKSorLC0uLw==",
        "displayName": "Sam Carter"
      },
      "createdAt": "2026-11-01T09:00:00Z",
      "expiresAt": "2026-11-08T09:00:00Z"
    }
  ]
}