# Organization API: Organizations & Members: Members

> The 4 Organization API operations for members.

Source: https://www.coritan.com/docs/api/reference/organizations/organizations-members/members/

Part of [Organizations & Members](/docs/api/reference/organizations/organizations-members/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/members`](#op-get-api-v1-orgs-org-slug-members) | List members |
| POST | [`/api/v1/orgs/{org_slug}/members`](#op-post-api-v1-orgs-org-slug-members) | Invite member |
| PATCH | [`/api/v1/orgs/{org_slug}/members/{member_id}`](#op-patch-api-v1-orgs-org-slug-members-member-id) | Update member |
| DELETE | [`/api/v1/orgs/{org_slug}/members/{member_id}`](#op-delete-api-v1-orgs-org-slug-members-member-id) | Remove member |

### List members {#op-get-api-v1-orgs-org-slug-members}

`GET /api/v1/orgs/{org_slug}/members`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

A `200` response is a list; each item has these fields:

| Field | Type |
| --- | --- |
| `[].id` | integer |
| `[].org_id` | integer |
| `[].user_id` | integer |
| `[].role` | string |
| `[].permissions` | object or null |
| `[].joined_at` | string (date-time) or null |
| `[].customer_link_mode` | string or null |
| `[].linked_customer_id` | integer or null |
| `[].email` | string or null |
| `[].first_name` | string or null |
| `[].last_name` | string or null |

### Invite member {#op-post-api-v1-orgs-org-slug-members}

`POST /api/v1/orgs/{org_slug}/members`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `email` | string | yes |
| `role` | string | no |
| `name` | string or null | no |
| `password` | string or null | no |
| `send_invite_email` | boolean | no |
| `permissions` | object or null | no |
| `customer_link` | string | no |
| `customer_id` | integer or null | no |

#### Responses

| Status | Meaning |
| --- | --- |
| `201` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `201` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `org_id` | integer |
| `user_id` | integer |
| `role` | string |
| `permissions` | object or null |
| `joined_at` | string (date-time) or null |
| `customer_link_mode` | string or null |
| `linked_customer_id` | integer or null |
| `email` | string or null |
| `first_name` | string or null |
| `last_name` | string or null |

### Update member {#op-patch-api-v1-orgs-org-slug-members-member-id}

`PATCH /api/v1/orgs/{org_slug}/members/{member_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `role` | string or null | no |
| `permissions` | object or null | no |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

Fields of a `200` response:

| Field | Type |
| --- | --- |
| `id` | integer |
| `org_id` | integer |
| `user_id` | integer |
| `role` | string |
| `permissions` | object or null |
| `joined_at` | string (date-time) or null |
| `customer_link_mode` | string or null |
| `linked_customer_id` | integer or null |
| `email` | string or null |
| `first_name` | string or null |
| `last_name` | string or null |

### Remove member {#op-delete-api-v1-orgs-org-slug-members-member-id}

`DELETE /api/v1/orgs/{org_slug}/members/{member_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `member_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |