---
title: "Get segment by external ID"
method: GET
path: "/v2/segments/external/{externalId}"
tags: ["Segments"]
---

# Get segment by external ID

`GET /v2/segments/external/{externalId}`

## Request

- Base URL: `https://api.attentivemobile.com`
- URL: `https://api.attentivemobile.com/v2/segments/external/{externalId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}`
    - Token URL: `https://api.attentivemobile.com/v1/authorization-codes/tokens` scopes: `segments:read`

Retrieves segment details by external ID.

Scopes Required: [segments:Read OR segments:Write]

Default Rate Limit: 100 requests per second

## Path parameters

- `externalId` string, required

## Response `200`

Segment details

- SegmentResponse
  - `externalId` string: The external segment ID (client-facing identifier)
  - `name` string: The name of the segment
  - `description` string: The description of the segment
  - `created` string, date-time: When the segment was created (ISO 8601 format)
  - `updated` string, date-time: When the segment was last updated (ISO 8601 format)

## Other responses

- `401`: Unauthorized - invalid or missing token
- `403`: Access denied - insufficient permissions
- `404`: Segment not found
- `429`: Too many requests - rate limit exceeded
- `500`: Internal server error

## Changes

- **2026-11-03** `2f49ffff7d65`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/attentive/apis/attentive-api-v2/changes/v2/segments/external/:externalId/get.md)

---

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