---
title: "Get a segment group"
method: GET
path: "/{teamPid}/segment-groups/{segmentGroup}"
tags: ["Segment groups"]
---

# Get a segment group

`GET /{teamPid}/segment-groups/{segmentGroup}`

## Request

- Base URL: `https://api.rightmessage.com/v1`
- URL: `https://api.rightmessage.com/v1/{teamPid}/segment-groups/{segmentGroup}`
- Auth: HTTP bearer

Requires an API token with the `read` or `write` ability. Tokens created without abilities have `*`, which grants every ability.

## Path parameters

- `teamPid` string, required
- `segmentGroup` string, required

## Response `200`

`SegmentGroupResource`

- object
  - `data` SegmentGroupResource, required
    - `id` string, nullable, required
    - `name` string, nullable, required
    - `semantic_type` string, nullable, required
    - `allow_multiple` union, required
      - string
      - boolean
    - `segments` object, required
    - `signals` union, required
      - string
      - string[]
    - `sync_platform` string, nullable, required
    - `sync_field` string, nullable, required
    - `sync_mode` union, required
      - string
      - 'field'
    - `sync_mappings` string, required

## Other responses

- `401`: Missing, invalid or revoked API token.
- `404`: Not found
- `429`: Rate limit exceeded: 120 requests per minute for project endpoints, 60 per minute for token and connection endpoints. Retry after the `Retry-After` seconds.

---

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