Members
The people in a workspace and its pending invitations, with their grants; list them or remove a member.
Belongs to: Users
- GET
List members/workspaces /{workspace_id} /members - DELETE
Remove a member/workspaces /{workspace_id} /members /{user_id}
Member object
A member is a person in the workspace, with the grants and groups that give them access.
user_id stringrequiredThe member's user id.
emailemailrequiredThe member's email address.
full_name string or nullrequiredThe member's full name.
display_name string or nullrequiredThe name the app shows for the member.
is_self booleanrequiredWhether the member is you.
created_at date-timerequiredWhen the member joined the workspace.
deleted_at date-time or nullrequiredWhen the person's account was deleted; null while it is active.
The member's own grants you are shown: all of yours, and anyone else's inside your reach. Grants held through a group are on the group.
other_grants booleanrequiredTrue when the member holds a grant you are not shown.
groupsarray of GroupRefrequiredThe groups the member is in that group.read shows you; on your own row, every group you are in.
List members
/workspaces/{workspace_id}/members Returns the workspace's members, deleted accounts included, each with its grants, a page at a time, oldest membership first. Needs member.read; you see the members your reach contains, with their grants inside it. Pending invitations are listed by list-invitations. A workspace token's grants are not listed here; the app lists them, and they change through the grant calls. Without member.read over every organization, a member is listed only through a grant at or below an organization you reach, so a member with no such grant, or none at all, is not listed.
- Request
- Response
- curl
- PowerShell
- Python
curl -X GET \ "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/members" \ -H "Authorization: Bearer $SPARKLOGS_TOKEN"Invoke-RestMethod -Method Get ` -Uri "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/members" ` -Headers @{ Authorization = "Bearer $env:SPARKLOGS_TOKEN" }import os import requests response = requests.get( "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/members" , headers={"Authorization": f"Bearer {os.environ['SPARKLOGS_TOKEN']}"},)response.raise_for_status(){ "message": "members retrieved", "members": [ { "user_id": "AlexRiveraExampleUserId00001", "email": "alex.rivera@example.com", "full_name": "Alex Rivera", "display_name": "Alex", "is_self": false, "created_at": "2026-11-01T09:00:00Z", "deleted_at": null, "grants": [ { "id": "6a170000-0000-4000-8000-000000000501", "role_id": "admin", "scope": { "kind": "all", "org_ids": [], "inherited": false, "other_orgs": false } } ], "other_grants": false, "groups": [] }, { "user_id": "SamChenExampleUserId00000002", "email": "sam.chen@example.com", "full_name": "Sam Chen", "display_name": "Sam", "is_self": false, "created_at": "2026-11-02T10:00:00Z", "deleted_at": null, "grants": [ { "id": "6a170000-0000-4000-8000-000000000502", "role_id": "engineer", "scope": { "kind": "selected", "org_ids": [ "0a9e0000-0000-4000-8000-000000000101" ], "inherited": false, "other_orgs": false } } ], "other_grants": false, "groups": [ { "id": "9a0b0000-0000-4000-8000-000000000401", "name": "Helpdesk Tier 1" } ] } ], "next_cursor": null}Access
- Works with
- Signed-in person, Personal token, OAuth token, Workspace token
- Scope
- any of
admin:readadmin:write - Privilege
member.read
Needs member.read. member.read applies at each organization a grant covers and every organization below it. A caller who reaches no organization gets an empty list.
Behavior
- Retry
- Safe to send again
- Paging
- Cursor · 1000 a page by default, up to 5000
Path parameters
workspace_id uuidrequiredThe workspace's id.
Query parameters
emailstringOnly the member with this email address. A person you are not shown answers an empty page, as one who is no member does. Matched exactly, ignoring case; every match you can see is returned. Spaces around the value are ignored.
limitintegerHow many members a page holds: 1 to 5000, 1000 by default.
cursorstringThe next_cursor of the previous page, with the same filters.
Response 200
The members you are shown, deleted accounts included, oldest membership first.
next_cursor string or nullrequiredNull on the last page. Otherwise pass it as cursor, with the same filters, for the next page.
messagestringrequiredWhat the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.
Errors
400APP_API_ERR_BAD_PARAMETERS A query parameter it does not take, or one given twice.NoAPP_API_ERR_BAD_PARAMETERS A filter's value is empty, names an empty item, is not one of the values the filter takes, or is not an id or a time where the filter asks for one; parameter names the filter.NoAPP_API_ERR_BAD_PARAMETERS limit is not 1 to 5000, or cursor cannot be read or was sent with other filters.No403APP_API_ERR_NO_PRIVILEGE token_scopeno_privilegeYou do not hold member.read. The same refusal comes when the path names a workspace other than the token's own.NoPlus the errors every call can return.
Related
Remove a member
/workspaces/{workspace_id}/members/{user_id} Removes a member from the workspace with their grants, their group memberships and every personal token and connected app they hold there. Needs member.manage, and the member must sit inside your reach. A repeat returns 404 once the member is gone: treat that as done. When cache_clear_status is not ok, a region the change did not reach can act on the earlier state for up to 15 minutes.
- Request
- Response
- curl
- PowerShell
- Python
curl -X DELETE \ "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/members/SamChenExampleUserId00000002" \ -H "Authorization: Bearer $SPARKLOGS_TOKEN"Invoke-RestMethod -Method Delete ` -Uri "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/members/SamChenExampleUserId00000002" ` -Headers @{ Authorization = "Bearer $env:SPARKLOGS_TOKEN" }import os import requests response = requests.delete( "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/members/SamChenExampleUserId00000002" , headers={"Authorization": f"Bearer {os.environ['SPARKLOGS_TOKEN']}"},)response.raise_for_status(){ "message": "user removed from workspace", "cache_clear_status": "ok"}Access
- Works with
- Signed-in person, Personal token, OAuth token, Workspace token
- Scope
admin:write- Privilege
member.manage
Needs member.manage. member.manage applies at each organization a grant covers and every organization below it.
Behavior
- Retry
- Safe to repeat: ends in the same state
- Audit log
- Recorded
Path parameters
workspace_id uuidrequiredThe workspace's id.
user_id stringrequiredThe member's user id.
Response 200
cache_clear_status one of the values below, or nullSent when the change has to reach every region's cache: how far it got.
okEvery region's cache has the change.failedA region could not be reached. The change is saved, and that region can act on the earlier state until its cache expires.disabledThis environment does not clear regional caches. The change is saved, and each region can act on the earlier state until its cache expires.
cache_clear_message string or nullSent with a cache_clear_status other than ok: what it means, for a person to read.
messagestringrequiredWhat the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.
Errors
400APP_API_ERR_BAD_PARAMETERS A query parameter it does not take, or one given twice.NoAPP_API_ERR_BAD_PARAMETERS The request carries a body other than nothing, null or {}: a delete takes none, and its options are query parameters; parameter names the body's first field, or body.No403APP_API_ERR_NO_PRIVILEGE token_scopeno_privilegeYou do not hold member.manage. The same refusal comes when the path names a workspace other than the token's own.NoAPP_API_ERR_BEYOND_OWN_AUTHORITY token_scopeThe member holds access you do not hold yourself. cause is token_scope only when the token's scopes alone stand in the way: given every scope, with its other limits as they are, the token would make the change.No404APP_API_ERR_RECORD_NOT_FOUND The user is not a member, or not one you can see.No409APP_API_ERR_LAST_ADMINISTRATOR The change would leave no administrator over every organization. Only a signed-in session meets this: no scope carries every privilege an Administrator holds, so an API token is refused with 403 first.No413APP_API_ERR_BODY_TOO_LARGE The body is larger than 1 MiB.NoPlus the errors every call can return.