List members
Retrieve a paginated list of members belonging to a specific organization. This endpoint provides access to member information including roles, invitation status, and contact details. Members can be filtered by various criteria and sorted by different attributes.
GET
Parameters
Path Parameters
OrganizationId
REQUIRED
Unique identifier of the organization
Query Parameters
Id
Filter resources by their unique identifier
Name
Filter resources by their name or title
Limit
How many items to return at one time (max 100)
Next
Pagination token for retrieving the next page of results
Order
Sort order for the results (ascending or descending)
SortBy
Field name to sort the results by
Status
filter by invite status
| Status code | Description |
|---|---|
| 200 | list of members |
| 400 | Bad request error - the request contains invalid parameters or malformed data |
| 500 | Internal server error - an unexpected error occurred on the server |
cURL
curl -L \"https://blockv-labs.io/organizations/{organizationId}/members?id={id}&name={name}&limit={limit}&next={next}&order={order}&sortBy={sortBy}&status={status}" \-H 'Accept: application/json'
Response
{"count": 1,"next": "string","members": [{"id": "string","wallet_id": "string","email": "string","invite_status": "pending","role_name": "string","when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}]}
json
{"type": "object","required": ["members","count"],"properties": {"count": {"type": "integer","description": "Total number of members in the organization"},"next": {"type": "string","description": "Pagination token for retrieving the next set of members","x-oapi-codegen-extra-tags": {"bson": "next,omitempty"}},"members": {"type": "array","description": "List of organization members returned in the response","x-oapi-codegen-extra-tags": {"bson": "members,omitempty"},"items": {"type": "object","required": ["id","email","role_name","invite_status","when_created"],"properties": {"id": {"type": "string","x-oapi-codegen-extra-tags": {"json": "id,omitempty","bson": "_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"wallet_id": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "wallet_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"email": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "email,omitempty"}},"invite_status": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "invite_status,omitempty"},"enum": ["pending","accepted","declined"],"x-go-type-skip-optional-pointer": true},"role_name": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "role_name,omitempty"}},"when_created": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"},"format": "date-time"},"when_modified": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "when_modified,omitempty"},"format": "date-time","x-go-type-skip-optional-pointer": true}}}}}}