Get members count by filter

get

https://app.officernd.com/api/v2/organizations/{orgSlug}/members/count

Retrieve a count of members based on provided filters

Required scopes: flex.community.members.read

Path Params

orgSlug

string

required

organization slug

Query Params

_id

string

Filter by the member id.

name

string

Filter by the name of the member. This returns a result only if the name is an exact match.

string

Filter by the email of the member. This returns a result only if the email is an exact match.

location

string

Filter by the location id of the member.

company

string

Filter by the company id of the member.

status

string

enum

Filter by the status of the member.
Accepts either a single status value or an array operator filter for multiple values.

        Single value: status=active
        Multiple values: status[$in]=active,pending

        Available status values: active, former, pending, contact, not_approved, drop-in, lead

Allowed:

isBillingPerson

boolean

Filter by whether the member is the billing person for their company.

createdAt

string

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAt

string

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

properties

string

Filter by custom properties. Uses deepObject style in query. Only string values are supported.

$countBy

string

enum

The field to count by

Allowed:

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200