---
title: "Check unsubscribe group membership"
method: GET
path: "/v1/unsubscribe-groups/check"
tags: ["Unsubscribe Groups"]
---

# Check unsubscribe group membership

`GET /v1/unsubscribe-groups/check`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/unsubscribe-groups/check`
- Auth: API key in header `x-api-key`

Returns the unsubscribe groups a contact has left, optionally limited to a specified set of groups. Name the contact by exactly one of `contactId`, `email`, or `phone`. Membership belongs to the contact, so the answer is the same whichever identifier names it; `contactId` is null, and no groups are returned, when no contact holds the email or phone.

## Query parameters

- `contactId` string
- `email` string, nullable
- `phone` string, nullable
- `groupIds` string, nullable

## Response `200`

Success

- object
  - `contactId` string, required
  - `unsubscribedGroups` object[], required
    - `groupId` string, required
    - `groupName` string, required
    - `unsubscribedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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