v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Members

Get members count by filter

Retrieve a count of members based on provided filters

Required scopes: flex.community.members.read

get/api/v2/organizations/{orgSlug}/members/count

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by the member id.

namestring

Example:John Doe

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

emailstring

Example:john.doe@example.com

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

locationstring

Example:603dfbc260f4054084125d33

Filter by the location id of the member.

companystring

Example:603dfbc260f4054084125d33

Filter by the company id of the member.

The status of the member.

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

isBillingPersonboolean

Example:true

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

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

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

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

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

propertiesstring

Example:properties[customProperty1]=value1

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

$countBy'status' | 'company' | 'location'

The field to count by

Response

totalnumber required