Skip to main content
GET
/
api
/
v1
/
bko
/
members
List Members
curl --request GET \
  --url https://api.example.com/api/v1/bko/members
{
  "data": [
    {
      "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user": {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "googleProviderId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "phoneIso": "<string>",
        "phoneDdi": "<string>",
        "phoneNumber": "<string>",
        "phoneVerified": true,
        "emailVerified": true,
        "avatar": "<string>",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "deletedAt": "2023-11-07T05:31:56Z"
      },
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": {
        "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "deletedAt": "2023-11-07T05:31:56Z"
      },
      "revokedAt": "2023-11-07T05:31:56Z",
      "revokedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

page
number
default:1

Page number.

pageSize
number
default:20

Items per page.

sort
string

Sort expression. Use comma-separated fields and prefix with - for descending order.

Search by user name, email or phone.

status
enum<string>

Filter by membership status.

Available options:
ACTIVE,
REVOKED
roleId
string<uuid>

Filter by internal role identifier.

Response

OK

data
object[]
required
meta
object
required

Pagination metadata