GET List manageable members, invitations and changes
/api/v1/members
Manage members across workspaces you own or administer. Only the submitted assignments change, atomically; revisions reject stale edits. Owners and admins have full access. Viewers and editors can use all groups or selected groups and separately enabled areas. Selected groups never reveal other monitors, their data or mixed results. New assignments default to Viewer, all groups and all areas in the member dialog. Each invitation link accepts its included workspaces together and requires the confirmed invited email. Changes require a fresh action-bound confirmation; admins may manage only other editors and viewers.
On this page
Access and permissions
Manage members across workspaces you own or administer. Only the submitted assignments change, atomically; revisions reject stale edits. Owners and admins have full access. Viewers and editors can use all groups or selected groups and separately enabled areas. Selected groups never reveal other monitors, their data or mixed results. New assignments default to Viewer, all groups and all areas in the member dialog. Each invitation link accepts its included workspaces together and requires the confirmed invited email. Changes require a fresh action-bound confirmation; admins may manage only other editors and viewers.
Browser session: __Host-mb_session cookie.
Parameters and headers
No path, query or additional request-header parameters.
Request body
No request body.
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | MemberDirectory | Yes | — |
| $.audit | array<object> | Yes | — |
| $.audit[] | object | Yes | — |
| $.audit[].action | string | Yes | — |
| $.audit[].actor_email | string | null | No | — |
| $.audit[].actor_id | string | null; {"format":"uuid"} | No | — |
| $.audit[].created_at | string; {"format":"date-time"} | Yes | — |
| $.audit[].id | integer | Yes | — |
| $.audit[].target_id | string | null; {"format":"uuid"} | No | — |
| $.audit[].workspace_id | string; {"format":"uuid"} | Yes | — |
| $.audit[].workspace_name | string | Yes | — |
| $.invitations | array<object> | Yes | — |
| $.invitations[] | object | Yes | — |
| $.invitations[].assignments | array<MemberDirectoryAssignment> | Yes | — |
| $.invitations[].assignments[] | MemberDirectoryAssignment | Yes | — |
| $.invitations[].assignments[].areas | array<string; {"enum":["logs","incidents","maintenance","slos","reports","keys","usage"]}> | Yes | — |
| $.invitations[].assignments[].areas[] | string; {"enum":["logs","incidents","maintenance","slos","reports","keys","usage"]} | Yes | — |
| $.invitations[].assignments[].group_ids | array<string; {"format":"uuid"}>; {"maxItems":100} | Yes | — |
| $.invitations[].assignments[].group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.invitations[].assignments[].group_mode | string; {"enum":["all","selected"]} | Yes | — |
| $.invitations[].assignments[].invitation_id | string; {"format":"uuid"} | No | — |
| $.invitations[].assignments[].revision | integer; {"minimum":0} | Yes | — |
| $.invitations[].assignments[].role | string; {"enum":["admin","editor","viewer","remove","owner"]} | Yes | — |
| $.invitations[].assignments[].workspace_id | string; {"format":"uuid"} | Yes | — |
| $.invitations[].assignments[].workspace_name | string | No | — |
| $.invitations[].email | string; {"format":"email"} | Yes | — |
| $.invitations[].expires_at | string; {"format":"date-time"} | Yes | — |
| $.invitations[].id | string; {"format":"uuid"} | Yes | — |
| $.members | array<object> | Yes | — |
| $.members[] | object | Yes | — |
| $.members[].account_id | string; {"format":"uuid"} | Yes | — |
| $.members[].assignments | array<MemberDirectoryAssignment> | Yes | — |
| $.members[].assignments[] | MemberDirectoryAssignment | Yes | — |
| $.members[].assignments[].areas | array<string; {"enum":["logs","incidents","maintenance","slos","reports","keys","usage"]}> | Yes | — |
| $.members[].assignments[].areas[] | string; {"enum":["logs","incidents","maintenance","slos","reports","keys","usage"]} | Yes | — |
| $.members[].assignments[].group_ids | array<string; {"format":"uuid"}>; {"maxItems":100} | Yes | — |
| $.members[].assignments[].group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.members[].assignments[].group_mode | string; {"enum":["all","selected"]} | Yes | — |
| $.members[].assignments[].invitation_id | string; {"format":"uuid"} | No | — |
| $.members[].assignments[].revision | integer; {"minimum":0} | Yes | — |
| $.members[].assignments[].role | string; {"enum":["admin","editor","viewer","remove","owner"]} | Yes | — |
| $.members[].assignments[].workspace_id | string; {"format":"uuid"} | Yes | — |
| $.members[].assignments[].workspace_name | string | No | — |
| $.members[].email | string; {"format":"email"} | Yes | — |
| $.workspaces | array<object> | Yes | — |
| $.workspaces[] | object | Yes | — |
| $.workspaces[].groups | array<object> | Yes | — |
| $.workspaces[].groups[] | object | Yes | — |
| $.workspaces[].groups[].id | string; {"format":"uuid"} | Yes | — |
| $.workspaces[].groups[].name | string | Yes | — |
| $.workspaces[].id | string; {"format":"uuid"} | Yes | — |
| $.workspaces[].name | string | Yes | — |
| $.workspaces[].role | string; {"enum":["owner","admin"]} | Yes | — |
| Stable error codes |
|---|
| unauthorized |
| invalid_credential |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| forbidden |
| csrf |
| invalid_origin |
| workspace_scope |
| confirmation_required |
| invalid_confirmation |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| not_found |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| already_invited |
| version_conflict |
| idempotency_conflict |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| invalid_input |
| invalid_token |
| invalid_reference |
| invalid_action |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| member_limit |
| rate_limited |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| unavailable |
| feature_unavailable |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"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.
curl --fail-with-body --request GET --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/members"import json, os, urllib.request
request = urllib.request.Request("https://metribeacon.com/api/v1/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))const response = await fetch("https://metribeacon.com/api/v1/members", {method: "GET", credentials: "same-origin", headers: {"Content-Type": "application/json", "X-CSRF-Token": csrfToken}});
console.log(response.status, await response.json());package main
import ("fmt"; "net/http"; "os"; "time")
func main() {
client := &http.Client{Timeout:30*time.Second}
request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/members", nil)
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 workspace assignments together
Manage members across workspaces you own or administer. Only the submitted assignments change, atomically; revisions reject stale edits. Owners and admins have full access. Viewers and editors can use all groups or selected groups and separately enabled areas. Selected groups never reveal other monitors, their data or mixed results. New assignments default to Viewer, all groups and all areas in the member dialog. Each invitation link accepts its included workspaces together and requires the confirmed invited email. Changes require a fresh action-bound confirmation; admins may manage only other editors and viewers.
- POST Accept a shared invitation link
Manage members across workspaces you own or administer. Only the submitted assignments change, atomically; revisions reject stale edits. Owners and admins have full access. Viewers and editors can use all groups or selected groups and separately enabled areas. Selected groups never reveal other monitors, their data or mixed results. New assignments default to Viewer, all groups and all areas in the member dialog. Each invitation link accepts its included workspaces together and requires the confirmed invited email. Changes require a fresh action-bound confirmation; admins may manage only other editors and viewers.
- POST Invite a member to several workspaces
Manage members across workspaces you own or administer. Only the submitted assignments change, atomically; revisions reject stale edits. Owners and admins have full access. Viewers and editors can use all groups or selected groups and separately enabled areas. Selected groups never reveal other monitors, their data or mixed results. New assignments default to Viewer, all groups and all areas in the member dialog. Each invitation link accepts its included workspaces together and requires the confirmed invited email. Changes require a fresh action-bound confirmation; admins may manage only other editors and viewers.