Skip to content
First
Esc
↑↓navigate↵open⌘Jpreview

List members

The members rows the caller may read, one page at a time. limit is 50 unless given, and at most 100; cursor is null on the last page.

Access: A signed-in user may do this to their own row only.

GET/members
Authorization
wordpress_logged_in_{hash}API key · cookierequired

WordPress's logged-in cookie, as a browser holds it after signing in. A request with it must also carry X-WP-Nonce.

X-WP-NonceAPI key · headerrequired

A WordPress REST nonce (wp_create_nonce('wp_rest')) for the cookie's session.

or
AuthorizationBasic auth · headerrequired

A WordPress user name and one of the user's application passwords.

or
AuthorizationBearer token (JWT) · headerrequired

A First Identity access token.

Query parameters
wherestring

A filter, as JSON: a value or operators per field, with AND, OR and NOT. A filter on a field the caller may not read is refused.

orderBystring

Fields to sort by, comma-separated; - before a field sorts it descending (-createdAt,title). Fields: id, email, name, plan, role.

limitinteger

How many rows to return: 50 unless given, and never more than 100.

min 1 · default: 50
offsetinteger

How many rows to skip.

min 0
cursorstring

The cursor of the previous page, to read the next one. It replaces offset.

searchstring

Words to find, each at the start of a word, in the title, the content and every text field the caller may read. Only rows the caller may read are found, in the list's own order.

max length 200
Responses
200

One page of rows.

dataMember[]required
Show properties
Array of Member
idinteger
emailstring
max length 191
namestring
max length 80
planstring
Allowed:freepro
rolestring
Allowed:guestsubscriberauthoreditoradmin
cursorstring | nullrequired
400

An error, as an RFC 9457 problem document.

typestringrequired

Always about:blank: code names the problem.

titlestringrequired

The problem in a few words.

statusintegerrequired

The HTTP status.

codestringrequired

A stable name for the problem, such as unauthenticated, forbidden, not_found, invalid_input, invalid_query, invalid_json, method_not_allowed, unique_violation or reference_violation.

detailstringrequired

What went wrong, for a person.

pointerstring

A JSON pointer to the field of the request at fault, when there is one.

401

An error, as an RFC 9457 problem document.

typestringrequired

Always about:blank: code names the problem.

titlestringrequired

The problem in a few words.

statusintegerrequired

The HTTP status.

codestringrequired

A stable name for the problem, such as unauthenticated, forbidden, not_found, invalid_input, invalid_query, invalid_json, method_not_allowed, unique_violation or reference_violation.

detailstringrequired

What went wrong, for a person.

pointerstring

A JSON pointer to the field of the request at fault, when there is one.

403

An error, as an RFC 9457 problem document.

typestringrequired

Always about:blank: code names the problem.

titlestringrequired

The problem in a few words.

statusintegerrequired

The HTTP status.

codestringrequired

A stable name for the problem, such as unauthenticated, forbidden, not_found, invalid_input, invalid_query, invalid_json, method_not_allowed, unique_violation or reference_violation.

detailstringrequired

What went wrong, for a person.

pointerstring

A JSON pointer to the field of the request at fault, when there is one.

default

An error, as an RFC 9457 problem document.

typestringrequired

Always about:blank: code names the problem.

titlestringrequired

The problem in a few words.

statusintegerrequired

The HTTP status.

codestringrequired

A stable name for the problem, such as unauthenticated, forbidden, not_found, invalid_input, invalid_query, invalid_json, method_not_allowed, unique_violation or reference_violation.

detailstringrequired

What went wrong, for a person.

pointerstring

A JSON pointer to the field of the request at fault, when there is one.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://example.space.fast/__first/api/v1/members' \
  -H 'X-WP-Nonce: YOUR_API_KEY' \
  -H 'Cookie: wordpress_logged_in_{hash}=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "id": 0,
      "email": "string",
      "name": "string",
      "plan": "free",
      "role": "guest"
    }
  ],
  "cursor": "string"
}