v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Members

Get members

Retrieve a list of members based on provided filters

Required scopes: flex.community.members.read

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

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.

$selectstring

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

$sortstring

Example:propertyName:asc

Sort expression in the format <field>:<order>, where order is asc or desc

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "603dfbc260f4054084125d33",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone": "012-345-6789",
      "image": "image-url.com",
      "description": "John Doe is an example member of the organization.",
      "location": "603dfbc260f4054084125d33",
      "company": "603dfbc260f4054084125d33",
      "startDate": "2025-01-01T00:00:00.000Z",
      "isBillingPerson": true,
      "isContactPerson": true,
      "address": {
        "country": "United States",
        "state": "California",
        "city": "San Francisco",
        "street": "123 Main St",
        "zip": "94105"
      },
      "billingDetails": {
        "billingName": "John Doe",
        "vatNumber": "123456789",
        "registrationNumber": "987654321",
        "paymentMethod": "Cash",
        "taxRate": "6780f1ba1e2f3a4b5c6d7e8f",
        "shouldSendOverdueReminders": true,
        "date": 15,
        "billingAddress": {
          "country": "United States",
          "state": "California",
          "city": "San Francisco",
          "street": "123 Main St",
          "zip": "94105"
        }
      },
      "portalPrivacy": {
        "isVisible": true,
        "showContactDetails": true,
        "showSocialProfiles": true
      },
      "socialProfiles": {
        "linkedin": "https://linkedin.com/in/johndoe",
        "twitter": "https://twitter.com/johndoe",
        "instagram": "https://instagram.com/johndoe",
        "facebook": "https://facebook.com/johndoe"
      },
      "createdAt": "2025-01-01T00:00:00.000Z",
      "createdBy": "603dfbc260f4054084125d33",
      "modifiedAt": "2025-01-01T00:00:00.000Z",
      "modifiedBy": "603dfbc260f4054084125d33",
      "tags": [
        "vip",
        "early-adopter"
      ]
    }
  ]
}