MetriBeacon
Menu
English
Sign inGo to account

GET List workspace members and invitations

/api/v1/workspaces/{id}/members

Workspace roles and management scopes are checked together. The owner pays shared quotas. Invitations expire after 48 hours and can only be accepted by the invited verified email address. Membership mutations require an action-bound email confirmation; repeating the same confirmation and payload replays the result without consuming it again. Removing Editor rights revokes issued credentials; member removal cancels their archive jobs. Status-page publishing permissions are separate.

On this page

Access and permissions

Workspace roles and management scopes are checked together. The owner pays shared quotas. Invitations expire after 48 hours and can only be accepted by the invited verified email address. Membership mutations require an action-bound email confirmation; repeating the same confirmation and payload replays the result without consuming it again. Removing Editor rights revokes issued credentials; member removal cancels their archive jobs. Status-page publishing permissions are separate.

Browser session: __Host-mb_session cookie.

Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesThe concrete workspace, member or invitation identifier. Foreign and unshared workspace identifiers grant no access.

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$object; {"additionalProperties":true}Yes—
Stable error codes
unauthorized
invalid_credential

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
forbidden
csrf
invalid_origin
workspace_scope
confirmation_required
invalid_confirmation

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
not_found

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
already_invited
version_conflict
idempotency_conflict

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_input
invalid_token
invalid_reference
invalid_action

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
member_limit
rate_limited

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
unavailable
feature_unavailable

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—

Retries and asynchronous work

This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

shell
curl --fail-with-body --request GET --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/members"
python
import json, os, urllib.request
request = urllib.request.Request("https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/members", method="GET", headers={"Cookie": os.environ["MB_COOKIE"], "X-CSRF-Token": os.environ["MB_CSRF"], "Content-Type": "application/json"}, data=None)
with urllib.request.urlopen(request, timeout=30) as response:
    print(json.load(response))
javascript
const response = await fetch("https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/members", {method: "GET", credentials: "same-origin", headers: {"Content-Type": "application/json", "X-CSRF-Token": csrfToken}});
console.log(response.status, await response.json());
go
package main
import ("fmt"; "net/http"; "os"; "strings"; "time")
func main() { client := &http.Client{Timeout:30*time.Second}; request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/members", strings.NewReader("")); if err != nil { panic(err) }; request.Header.Set("Cookie", os.Getenv("MB_COOKIE")); request.Header.Set("X-CSRF-Token",os.Getenv("MB_CSRF"));request.Header.Set("Content-Type","application/json");response,err:=client.Do(request);if err!=nil{panic(err)};defer response.Body.Close();fmt.Println(response.StatusCode) }

Related guides

  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • PATCH Change or remove a workspace member

    Workspace roles and management scopes are checked together. The owner pays shared quotas. Invitations expire after 48 hours and can only be accepted by the invited verified email address. Membership mutations require an action-bound email confirmation; repeating the same confirmation and payload replays the result without consuming it again. Removing Editor rights revokes issued credentials; member removal cancels their archive jobs. Status-page publishing permissions are separate.

  • GET Read workspace membership audit

    Workspace roles and management scopes are checked together. The owner pays shared quotas. Invitations expire after 48 hours and can only be accepted by the invited verified email address. Membership mutations require an action-bound email confirmation; repeating the same confirmation and payload replays the result without consuming it again. Removing Editor rights revokes issued credentials; member removal cancels their archive jobs. Status-page publishing permissions are separate.

  • POST Invite a verified account to a workspace

    Workspace roles and management scopes are checked together. The owner pays shared quotas. Invitations expire after 48 hours and can only be accepted by the invited verified email address. Membership mutations require an action-bound email confirmation; repeating the same confirmation and payload replays the result without consuming it again. Removing Editor rights revokes issued credentials; member removal cancels their archive jobs. Status-page publishing permissions are separate.