Sign in

v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
members

List members

Retrieves a paginated list of members from your workspace. Members represent users who have access to your Productboard workspace.

  • Members are sorted by creation date, oldest first.
  • Use the query parameter to search by name or email (case-insensitive, partial match).
  • Use the roles[] parameter to filter by role(s). Multiple roles use OR logic (e.g., roles[]=admin&roles[]=maker).
  • Use the includeDisabled parameter to include disabled members in the response.
  • Use the includeInvited parameter to include invited members with pending invitations.
  • Use the pageCursor parameter to paginate through results.

Without the members:pii:read OAuth scope, PII fields (name, username, email) are returned as [redacted].

get/members

Query parameters

pageCursorstring

Cursor for pagination.

querystring

Full-text search query. Performs case-insensitive partial match on member name or email.

roles[]string[]

Filter members by role(s). Use multiple roles[] parameters to match members with any of the specified roles (OR logic).

Examples:

  • Single role: roles[]=admin
  • Multiple roles: roles[]=admin&roles[]=maker
includeDisabledboolean

Include disabled members in the response. By default, disabled members are excluded.

includeInvitationPendingboolean

Include members with pending invitations in the response. By default, members with pending invitations are excluded.

includeInvitedboolean

Deprecated: Use includeInvitationPending instead. Include members with pending invitations in the response. By default, members with pending invitations are excluded.

Response

A paginated list of members

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "member",
      "fields": {
        "name": "John Doe",
        "username": "johndoe",
        "email": "email@example.com",
        "role": "maker",
        "teams": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "team",
            "links": {
              "self": "https://api.productboard.com/v2/teams/123e4567-e89b-12d3-a456-426614174000",
              "members": "https://api.productboard.com/v2/teams/123e4567-e89b-12d3-a456-426614174000/members",
              "html": "https://example.productboard.com/settings/teams/12"
            }
          }
        ]
      },
      "links": {
        "self": "https://api.productboard.com/v2/members/123e4567-e89b-12d3-a456-426614174000",
        "html": "https://example.productboard.com/settings/members/42"
      }
    }
  ]
}