Skip to main content
GET/members

List 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.

Parameters
userIdquery

Only the membership of this user (usr_...).

rolequery

Only members with this project role.

statequery

Only members in these states, comma-separated: invited (the invitation is not accepted) and active.

projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
401K9O_SESSION_EXPIREDYour session has expired; sign in again to continue.
403K9O_ACCESS_DENIEDYou do not have the required role (PROJECT_ADMIN or higher) to list project members.
410K9O_SLUG_GONEThe project slug in the URL has been renamed; update your integration to use the new slug.
Response body (200)
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 (usr_...).

projectId *string

The project's id (proj_...).

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"

invited while acceptedAt is null, otherwise active.

meta *any

Request metadata: cost, timing and the request and trace ids.

TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.org.members.list()

Showing example in TypeScript

Response example (200)
{
  "data": [
    {
      "userId": "string",
      "projectId": "string",
      "role": "PROJECT_ADMIN",
      "email": "string",
      "displayName": "string",
      "invitedAt": "string",
      "acceptedAt": "string",
      "state": "invited"
    }
  ]
}

More in Members & End Users