Search members

Purpose

Performs a filtered search over members using a POST request body. Supports batch lookups by IDs or emails, plus all filters from GET /v2/members.

Uses filter, search, and return objects under data.

Key Features

• filter.id: Filter by member UUIDs (OR logic, max 100)
• filter.fields.email: Filter by email addresses (OR logic, max 100, requires members_pii:read scope)
• filter.fields.role: Filter by roles (OR logic)
• filter.fields.disabled: Exclusive filter for disabled members (true = only disabled)
• filter.fields.invitationPending: Exclusive filter for pending members (true = only pending)
• search.query: Full-text search on name or email (requires members_pii:read scope)
• return.includeDisabled: Include disabled members alongside active
• return.includeInvitationPending: Include pending members alongside accepted

Filter Logic

• Multiple values within a filter use OR logic (e.g., filter.id with two UUIDs)
• Different filters use AND logic (e.g., filter.fields.email AND filter.fields.role)
• Disabled and invited members are excluded by default
• Use filter.fields.disabled: true to get only disabled members
• Use return.includeDisabled: true to include disabled alongside active members
• If both filter.fields.disabled and return.includeDisabled are set, the filter takes precedence

Important Notes

• The filter.id and filter.fields.email filters accept at most 100 items each; exceeding this returns a 400 error
• Filtering by email or query requires the members_pii:read scope; requests without it return a 400 error
• Unknown keys in filter.fields return a 400 error
• Pagination uses cursor-based navigation via pageCursor query parameter

{
  "data": {
    "filter": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

{
  "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"
      }
    }
  ]
}