---
updatedAt: 2026-04-21T05:36:32.000Z
agentTools:
  projectIndex: https://developer.officernd.com/llms.txt
---

# Get members count by filter

Retrieve a count of members based on provided filters 

 Required scopes: `flex.community.members.read`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/organizations/{orgSlug}/members/count": {
      "get": {
        "description": "Retrieve a count of members based on provided filters \n\n Required scopes: `flex.community.members.read`",
        "operationId": "MembersController_countBy_api/v2",
        "parameters": [
          {
            "name": "_id",
            "required": false,
            "in": "query",
            "description": "Filter by the member id.",
            "examples": {
              "singleType": {
                "summary": "Single _id value",
                "description": "Filter by a single _id value",
                "value": "id=603dfbc260f4054084125d33"
              },
              "multipleTypes": {
                "summary": "Multiple _id values",
                "description": "Filter by multiple _id values using array format",
                "value": "_id[$in]=603dfbc260f4054084125d33,603dfbc260f4054084125d34"
              }
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "required": false,
            "in": "query",
            "description": "Filter by the name of the member. This returns a result only if the name is an exact match.",
            "schema": {
              "example": "John Doe",
              "type": "string"
            }
          },
          {
            "name": "email",
            "required": false,
            "in": "query",
            "description": "Filter by the email of the member. This returns a result only if the email is an exact match.",
            "schema": {
              "example": "john.doe@example.com",
              "type": "string"
            }
          },
          {
            "name": "location",
            "required": false,
            "in": "query",
            "description": "Filter by the location id of the member.",
            "schema": {
              "example": "603dfbc260f4054084125d33",
              "type": "string"
            }
          },
          {
            "name": "company",
            "required": false,
            "in": "query",
            "description": "Filter by the company id of the member.",
            "schema": {
              "example": "603dfbc260f4054084125d33",
              "type": "string"
            }
          },
          {
            "name": "status",
            "required": false,
            "in": "query",
            "description": "Filter by the status of the member.\n            Accepts either a single status value or an array operator filter for multiple values.\n\n            Single value: status=active\n            Multiple values: status[$in]=active,pending\n\n            Available status values: active, former, pending, contact, not_approved, drop-in, lead",
            "examples": {
              "singleStatus": {
                "summary": "Single status value",
                "description": "Filter by a single member status",
                "value": "status=active"
              },
              "multipleStatuses": {
                "summary": "Multiple status values",
                "description": "Filter by multiple member statuses using the $in array operator",
                "value": "status[$in]=active,pending"
              },
              "excludeStatus": {
                "summary": "Exclude status values",
                "description": "Exclude specific statuses using the $nin operator",
                "value": "status[$nin]=former,lead"
              }
            },
            "schema": {
              "$ref": "#/components/schemas/MemberCalculatedStatus"
            }
          },
          {
            "name": "isBillingPerson",
            "required": false,
            "in": "query",
            "description": "Filter by whether the member is the billing person for their company.",
            "schema": {
              "example": true,
              "type": "boolean"
            }
          },
          {
            "name": "createdAt",
            "required": false,
            "in": "query",
            "description": "Support date comparison filters: $gt, $gte, $lt, $lte",
            "schema": {
              "example": "createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ",
              "type": "string"
            }
          },
          {
            "name": "modifiedAt",
            "required": false,
            "in": "query",
            "description": "Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte",
            "schema": {
              "example": "modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ",
              "type": "string"
            }
          },
          {
            "name": "properties",
            "required": false,
            "in": "query",
            "description": "Filter by custom properties. Uses deepObject style in query. Only string values are supported.",
            "schema": {
              "example": "properties[customProperty1]=value1",
              "type": "string"
            }
          },
          {
            "name": "$countBy",
            "required": false,
            "in": "query",
            "description": "The field to count by",
            "schema": {
              "$ref": "#/components/schemas/CountByFields"
            }
          },
          {
            "name": "orgSlug",
            "required": true,
            "in": "path",
            "description": "organization slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountResultDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "flex.community.members.read"
            ]
          }
        ],
        "summary": "Get members count by filter",
        "tags": [
          "Members"
        ]
      }
    }
  },
  "info": {
    "title": "Community API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.officernd.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          },
          "authorizationCode": {
            "authorizationUrl": "https://identity.officernd.com/auth/authorize",
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "MemberCalculatedStatus": {
        "type": "string",
        "enum": [
          "active",
          "former",
          "pending",
          "contact",
          "not_approved",
          "drop-in",
          "lead"
        ],
        "description": "The status of the member."
      },
      "GroupDto": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "count": {
            "type": "number"
          }
        },
        "required": [
          "key",
          "count"
        ]
      },
      "CountResultDto": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number"
          },
          "groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupDto"
            }
          }
        },
        "required": [
          "total"
        ]
      },
      "CountByFields": {
        "type": "string",
        "enum": [
          "status",
          "company",
          "location"
        ]
      }
    }
  }
}
```