---
title: "Retrieve members"
method: GET
path: "/members"
tags: ["Members"]
---

# Retrieve members

`GET /members`

Retrieve a paginated list of your members.

Active members are subscribed members that are part of group(s).
Orphan members are subscribed members that are not part of a group.

Note: The returned property `items_per_page` is deprecated and will eventually be removed. Use `limit` instead.

## Query parameters

- `page` integer
- `limit` integer
- `status` 'active' | 'orphans' | 'all'
- `sort` 'email_asc' | 'email_desc' | 'language_asc' | 'language_desc' | 'fullname_asc' | 'fullname_desc' | 'date_asc' | 'date_desc' | 'consent_type_asc' | 'consent_type_desc' | 'consent_date_asc' | 'consent_date_desc' | 'updated_asc' | 'updated_desc'
- `joinedOnFrom` string, date
- `joinedOnTo` string, date
- `updatedOnFrom` string, date
- `updatedOnTo` string, date

## Response `200`

Paginated list of members

- object
  - `members` Member[]
    - `id` integer
    - `firstname` string
    - `lastname` string
    - `company` string
    - `email` string, email
    - `gender` string — m, f or o
    - `language` string — en_ca or fr_ca
    - `joinedOn` string, nullable
    - `updatedOn` string, nullable
    - `consentType` string
    - `postalCode` string
    - `country` string — ISO 3166-1 alpha-2 country code
    - `note` string
    - `birthdate` string, nullable
    - `mailingsReceived` integer
    - `mailingsOpened` integer
    - `mailingsClicked` integer
    - `customFields` object
  - `totalCount` integer
  - `page` integer
  - `limit` integer
  - `items_per_page` integer — Deprecated — use limit instead
  - `sort` string

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/cyberimpact/apis/cyberimpact-api.md) · [All operations](https://skmtc.net/cyberimpact/apis/cyberimpact-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cyberimpact/cyberimpact-api/revisions/bf0b51ee8e8a/schema)