Skip to content

Workspace: members

View as Markdown

The owners in the workspace and which of them administer it

Section titled “The owners in the workspace and which of them administer it”

GET /v1/workspace/members · operation listMembers

Requires the batondeck:members:read permission (action member:list).

Responses

Status Meaning
200 The owners in the workspace and which of them administer it
401 No portal session, and no live API key.
403 The policy refused, or the request was cross-site.
404 No such resource, or none this session may see.
200 response schema
{
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"owner_id": {
"type": "string"
},
"name": {
"type": "string"
},
"workspace_admin": {
"type": "boolean"
},
"role": {
"type": "string"
},
"created_at": {
"type": "number"
}
},
"required": [
"owner_id",
"name",
"workspace_admin",
"role",
"created_at"
],
"additionalProperties": false
}
}
},
"required": [
"members"
],
"additionalProperties": false
}
Terminal window
curl -X GET 'https://api.batondeck.com/v1/workspace/members' \
-H "Authorization: Bearer $BATONDECK_API_KEY"