---
title: "List members"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › organizations

`GET /v2/organizations/{id}/members`

## Path parameters

- `id` (`organization-list-members.path.id`; string, required)
  - minLength 1; maxLength 160

## Query parameters

- `includeRevoked` (`organization-list-members.query.includeRevoked`; boolean, optional)
  - default `false`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/organizations/<id>/members'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/organizations/<id>/members';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/organizations/<id>/members"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organizationId": "string",
      "userId": "string",
      "role": "owner",
      "status": "string",
      "joinedAt": "2019-08-24T14:15:22Z",
      "revokedAt": "2019-08-24T14:15:22Z",
      "invitedBy": "string",
      "organization": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "description": "string",
        "organizationType": "string",
        "status": "string"
      },
      "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "avatar": "string",
        "title": "string",
        "company": "string"
      },
      "inviter": {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}
```

- `data` (`organization-list-members.response.200.data`; array<object>, required)
  - `id` (`organization-list-members.response.200.data.id`; string, required)
    - format `uuid`
  - `organizationId` (`organization-list-members.response.200.data.organizationId`; string, required)
  - `userId` (`organization-list-members.response.200.data.userId`; string, required)
  - `role` (`organization-list-members.response.200.data.role`; string, required)
    - one of `"owner"`, `"admin"`, `"member"`, `"viewer"`
  - `status` (`organization-list-members.response.200.data.status`; string, required)
  - `joinedAt` (`organization-list-members.response.200.data.joinedAt`; string, optional, nullable)
    - format `date-time`
  - `revokedAt` (`organization-list-members.response.200.data.revokedAt`; string, optional, nullable)
    - format `date-time`
  - `invitedBy` (`organization-list-members.response.200.data.invitedBy`; string, optional, nullable)
  - `organization` (`organization-list-members.response.200.data.organization`; object, optional)
    - `id` (`organization-list-members.response.200.data.organization.id`; string, required)
    - `name` (`organization-list-members.response.200.data.organization.name`; string, required)
    - `slug` (`organization-list-members.response.200.data.organization.slug`; string, required)
    - `description` (`organization-list-members.response.200.data.organization.description`; string, optional, nullable)
    - `organizationType` (`organization-list-members.response.200.data.organization.organizationType`; string, optional, nullable)
    - `status` (`organization-list-members.response.200.data.organization.status`; string, optional)
  - `user` (`organization-list-members.response.200.data.user`; object, optional)
    - `id` (`organization-list-members.response.200.data.user.id`; string, required)
    - `name` (`organization-list-members.response.200.data.user.name`; string, required, nullable)
    - `email` (`organization-list-members.response.200.data.user.email`; string, required, nullable)
    - `avatar` (`organization-list-members.response.200.data.user.avatar`; string, required, nullable)
    - `title` (`organization-list-members.response.200.data.user.title`; string, optional, nullable)
    - `company` (`organization-list-members.response.200.data.user.company`; string, optional, nullable)
  - `inviter` (`organization-list-members.response.200.data.inviter`; object, optional)
    - `id` (`organization-list-members.response.200.data.inviter.id`; string, required)
    - `name` (`organization-list-members.response.200.data.inviter.name`; string, required, nullable)
    - `email` (`organization-list-members.response.200.data.inviter.email`; string, required, nullable)
- `meta` (`organization-list-members.response.200.meta`; object, required)
  - `total` (`organization-list-members.response.200.meta.total`; number, required) — Total number of items available
  - `limit` (`organization-list-members.response.200.meta.limit`; number, required) — Number of items per page
  - `offset` (`organization-list-members.response.200.meta.offset`; number, required) — Number of items skipped
  - `hasMore` (`organization-list-members.response.200.meta.hasMore`; boolean, required) — Whether more items are available
  - `page` (`organization-list-members.response.200.meta.page`; number, optional) — Current page number
  - `totalPages` (`organization-list-members.response.200.meta.totalPages`; number, optional) — Total number of pages

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`organization-list-members.response.400.error`; object, required)
  - `code` (`organization-list-members.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`organization-list-members.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`organization-list-members.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`organization-list-members.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`organization-list-members.response.401.error`; object, required)
  - `code` (`organization-list-members.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`organization-list-members.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`organization-list-members.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`organization-list-members.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`organization-list-members.response.403.error`; object, required)
  - `code` (`organization-list-members.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`organization-list-members.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`organization-list-members.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`organization-list-members.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`organization-list-members.response.500.error`; object, required)
  - `code` (`organization-list-members.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`organization-list-members.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`organization-list-members.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`organization-list-members.response.500.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/organization-list-members/index.md