---
title: "Get members"
method: GET
path: "/api/v2/organizations/{orgSlug}/members"
tags: ["Members"]
---

# Get members

`GET /api/v2/organizations/{orgSlug}/members`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/members`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.community.members.read`

Retrieve a list of members based on provided filters 

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

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `name` string
- `email` string
- `location` string
- `company` string
- `status` 'active' | 'former' | 'pending' | 'contact' | 'not_approved' | 'drop-in' | 'lead': The status of the member.
- `isBillingPerson` boolean
- `createdAt` string
- `modifiedAt` string
- `properties` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number
- `$sort` string

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` MemberResultDto[]
    - `properties` object: An object that contains all custom properties that can be applied to the item.
    - `_id` string: The unique identifier of the member.
    - `name` string: The exact name of the item you are looking for. Also, you can use this property to perform a wildcard match.
    - `email` string: The email of the member.
    - `phone` string: The primary phone number of the member.
    - `image` string: The logo/image URL of the member.
    - `description` string: The description/bio of the member.
    - `location` string: Reference to the location of the member.
    - `company` string: Reference to the company the member belongs to.
    - `status` 'active' | 'former' | 'pending' | 'contact' | 'not_approved' | 'drop-in' | 'lead': The status of the member.
    - `startDate` string, date-time: The starting date of the member.
    - `isBillingPerson` boolean: True if the member is the billing person of his company and receives all the invoices.
    - `isContactPerson` boolean: True if the member is a contact person in his company.
    - `address` AddressResultDto
      - `country` string: The country of the address.
      - `state` string: The state of the address.
      - `city` string: The city of the address.
      - `street` string: The street of the address.
      - `zip` string: The zip of the address.
    - `billingDetails` MemberBillingDetailsResultDto
      - `billingName` string: The billing name of the member that will appear on transactions and invoices.
      - `vatNumber` string: The VAT number of the member.
      - `registrationNumber` string: The registration number of the member.
      - `paymentMethod` string: The payment method of the member.
      - `taxRate` string: A reference to the tax rate that will be applied to the member.
      - `shouldSendOverdueReminders` boolean: Whether overdue invoice reminders should be sent for this member.
      - `date` number: Day of month (1–31) for the billing cycle.
      - `billingAddress` AddressResultDto
        - `country` string: The country of the address.
        - `state` string: The state of the address.
        - `city` string: The city of the address.
        - `street` string: The street of the address.
        - `zip` string: The zip of the address.
    - `portalPrivacy` PortalPrivacyResultDto
      - `isVisible` boolean: Determines whether the member's profile is visible in the members portal.
      - `showContactDetails` boolean: Determines whether the member's contact details are visible in the members portal.
      - `showSocialProfiles` boolean: Determines whether the member's (Twitter, LinkedIn, Facebook, Instragram) socials are visible in the members portal.
    - `socialProfiles` SocialProfilesResultDto
      - `linkedin` string: LinkedIn profile URL or handle
      - `twitter` string: Twitter/X profile URL or handle
      - `instagram` string: Instagram profile URL or handle
      - `facebook` string: Facebook profile URL
    - `createdAt` string, date-time: The date of creation of the member. It may be different from the start date.
    - `createdBy` string: The user that created the member.
    - `modifiedAt` string, date-time: The date of the last update of the member.
    - `modifiedBy` string: The user that did the last modification to the member. If no update is made this field will match the "createdBy" field.
    - `tags` string[]: An array of tags associated with the member.

---

[API](https://skmtc.dev/officernd/apis/community-api.md) - [All operations](https://skmtc.dev/officernd/apis/community-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/community-api/revisions/dad1b7912165?raw)