/membersList Members
Returns a list of members for the specified project.
Org admins and owners with the auto-granted PROJECT_ADMIN role are included via join-time evaluation.
Requires a project or org membership granting access.
| userId | query | Only the membership of this user ( |
| role | query | Only members with this project role. |
| state | query | Only members in these states, comma-separated: |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 401 | K9O_SESSION_EXPIRED | Your session has expired; sign in again to continue. |
| 403 | K9O_ACCESS_DENIED | You do not have the required role (PROJECT_ADMIN or higher) to list project members. |
| 410 | K9O_SLUG_GONE | The project slug in the URL has been renamed; update your integration to use the new slug. |
| data * | object[] | The project's members, oldest membership first, narrowed by the query filters. Empty when none match. |
| userId * | string | The member's user id ( |
| projectId * | string | The project's id ( |
| role * | "PROJECT_ADMIN" | "PROJECT_EDITOR" | "PROJECT_MEMBER" | "PROJECT_VIEWER" | "PROJECT_AUDITOR" | "PROJECT_AUTHOR" | "PROJECT_ANALYST" | The member's explicit project role. Org owners and admins also have admin access to every project without a row here, and are listed only if they have one. |
| email * | string | The member's sign-in email address. |
| displayName * | string | The member's display name. |
| invitedAt * | string <date-time> | When the membership was created. |
| acceptedAt * | any | When the membership was accepted, or null while it is still an invitation. |
| One of: string <date-time> | ||
| or: null | ||
| state * | "invited" | "active" |
|
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.org.members.list()Showing example in TypeScript
{
"data": [
{
"userId": "string",
"projectId": "string",
"role": "PROJECT_ADMIN",
"email": "string",
"displayName": "string",
"invitedAt": "string",
"acceptedAt": "string",
"state": "invited"
}
]
}