Skip to main content
GET
/
organizations
/
{organization}
/
members
List organization members
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/members \
  --header 'Authorization: <api-key>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "user": {
        "id": "<string>",
        "display_name": "<string>",
        "name": "<string>",
        "email": "<string>",
        "avatar_url": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "two_factor_auth_configured": true,
        "default_organization": {
          "id": "<string>",
          "name": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "deleted_at": "<string>"
        },
        "sso": true,
        "managed": true,
        "directory_managed": true,
        "email_verified": true
      },
      "role": "member",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required

The name of the organization

Query Parameters

q
string

Search term to filter members by name or email

page
integer
default:1

If provided, specifies the page offset of returned results

per_page
integer
default:25

If provided, specifies the number of returned results

Response

Returns members of the organization

current_page
integer
required

The current page number

next_page
integer
required

The next page number

next_page_url
string
required

The next page of results

prev_page
integer
required

The previous page number

prev_page_url
string
required

The previous page of results

data
object[]
required