# Get members

> Retrieve all members with optional pagination

Breadcrumb: API v1 › Get members · Status: Legacy
Docs index: https://docs.cevoid.com/developers/llms.txt

`GET https://api.cevoid.com/v1/members`

Retrieve all members with optional pagination

## Authorizations

API key in the x-api-key header: `x-api-key: <key>`.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `number` | No | Max value for limit is 25 Default: `25`. Range: `1 <= x <= 25`. Example: `10`. |
| `skip` | `number \| null` | No | Number of items to skip Default: `0`. Range: `0 <= x`. Example: `0`. |
| `market` | `string` | No | Market ID or shortId for localized content Example: `us`. |

## Response

### 200: Successful response

`application/json`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `count` | `number` | Yes | Total number of items |
| `next` | `string \| null` | Yes | URL for next page |
| `nodes` | `object[]` | Yes |  |
| `nodes[].id` | `string` | Yes | Unique identifier for the member within the Cevoid system Example: `member_abc123def456`. |
| `nodes[].shortId` | `string` | Yes | Shortened, human-readable identifier for the member, often used in URLs and public references Example: `mem_5a8b9c`. |
| `nodes[].name` | `string` | No | Display name or full name of the member as provided during registration or profile updates Example: `Sarah Johnson`. |
| `nodes[].email` | `string` | No | Email address associated with the member account, used for communication and authentication Example: `sarah.johnson@example.com`. |
| `nodes[].avatarUrl` | `string` | No | URL to the member's profile picture or avatar image Example: `https://cdn.cevoid.com/avatars/member123/profile.jpg`. |
| `nodes[].country` | `string` | No | ISO 3166-1 alpha-2 country code representing the member's country of residence Example: `US`. |
| `nodes[].language` | `string` | No | ISO 639-1 language code representing the member's preferred language for communications Example: `en`. |
| `nodes[].location` | `string` | No | Geographic location information such as city, state, or region provided by the member Example: `San Francisco, CA`. |
| `nodes[].socialInstagramHandle` | `string` | No | Instagram username/handle associated with the member's social media account, without the @ symbol Example: `sarah.lifestyle`. |
| `nodes[].bio` | `string` | No | Biography or description provided by the member Example: `Lifestyle blogger and photography enthusiast`. |
| `nodes[].notes` | `string` | No | Internal notes about the member for company reference Example: `VIP customer, prefers email communication`. |
| `nodes[].createdAt` | `string` | Yes | ISO 8601 timestamp indicating when the member account was first created in the system Example: `2024-01-15T09:30:00.000Z`. |
| `nodes[].updatedAt` | `string` | Yes | ISO 8601 timestamp indicating when the member was last updated Example: `2024-01-20T14:22:15.000Z`. |

```json
{
  "count": 0,
  "next": "string",
  "nodes": [
    {
      "id": "member_abc123def456",
      "shortId": "mem_5a8b9c",
      "name": "Sarah Johnson",
      "email": "sarah.johnson@example.com",
      "avatarUrl": "https://cdn.cevoid.com/avatars/member123/profile.jpg",
      "country": "US",
      "language": "en",
      "location": "San Francisco, CA",
      "socialInstagramHandle": "sarah.lifestyle",
      "bio": "Lifestyle blogger and photography enthusiast",
      "notes": "VIP customer, prefers email communication",
      "createdAt": "2024-01-15T09:30:00.000Z",
      "updatedAt": "2024-01-20T14:22:15.000Z"
    }
  ]
}
```

### 400: Bad request

`application/json`

Type: `string`.

```json
"string"
```

### 401: Unauthorized

`application/json`

Type: `enum<string>`. Allowed value: `No valid API key provided`.

```json
"No valid API key provided"
```

### 500: Internal server error

`application/json`

Type: `enum<string>`. Allowed value: `Something went wrong`.

```json
"Something went wrong"
```

## Request example

```bash
curl 'https://api.cevoid.com/v1/members' \
  -H "x-api-key: ${CEVOID_API_KEY}"
```

---

Canonical: https://docs.cevoid.com/developers/api/v1/members/get-members
