APIMembers
List members
Lists the people in the workspace with their role and profile. Filter by role, or search by name and email.
Requires membership of the workspace.
GET
header
AuthorizationBearer <JWT>An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.
workspaceId*stringThe workspace's id.
cursor?stringThe nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.
limit*|How many items to return, from 1 to 200.
Range
1 <= value <= 200Default
50q?stringMatch part of a name or email address.
Length
length <= 255role?MemberRolemember is a regular collaborator. admin can also administer the workspace, its members, and its websites.
Value in
"admin""member"A page of members.
application/json- response
data*array<>The members on this page.
pagination*Where this page sits in the full result set.
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/members?limit=50'Example Response
{ "data": [ { "id": "string", "workspaceId": "string", "userId": "string", "role": "admin", "email": "string", "firstName": "string", "lastName": "string", "picture": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "pagination": { "nextCursor": "string", "hasMore": true, "total": 0 }}