---
title: "Get segment"
method: GET
path: "/api/segments"
tags: ["Segment"]
---

# Get segment

`GET /api/segments`

Retrieves information about the segment, which contains additional data related to the session's context.


You can add certain public fields as the query string and the system will attempt to fulfill it. Values such as `cultureInfo` and `utm` are overwriteable, just keep in mind such changes will not be reflected in the client's session.


If you wish to change the value on the session (and thus be reflected on the segment without special query strings), then use the [Edit session](https://developers.vtex.com/docs/api-reference/session-manager-api#patch-/api/sessions) endpoint.

## Permissions

This endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

## Response `200`

OK

- Segment — Object containing information about the segment.
  - `campaigns` string, nullable — Campaigns associated with the session.
  - `channel` string — [Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID.
  - `priceTables` string, nullable — Price tables associated with the session.
  - `regionId` string — ID of the session's region.
  - `utm_campaign` string, nullable — UTM campaign code.
  - `utm_source` string, nullable — UTM source code.
  - `utmi_campaign` string, nullable — UTMI campaign code.
  - `currencyCode` string — Currency code.
  - `currencySymbol` string — Currency symbol.
  - `countryCode` string — Country code.
  - `cultureInfo` string — Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read [this documentation](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-7.0#culture-names-and-identifiers) for more details.
  - `channelPrivacy` string — Defines whether or not the channel is private.

## Changes

- **2024-06-12** `b4426af46a3b` — 4 breaking
  - the response property `priceTables` became nullable for the status `200`
  - the response property `utm_campaign` became nullable for the status `200`
  - the response property `utm_source` became nullable for the status `200`
  - the response property `utmi_campaign` became nullable for the status `200`
- **2024-06-12** `235ce3f45f18` — 1 breaking
  - the response property `campaigns` became nullable for the status `200`
- **2023-08-24** `28855b35a98d` — 1 info
  - added the media type `application/json` for the response with the status `200`
- **2023-08-24** `7942fc2b28eb` — 1 info
  - the endpoint scheme security `vtex_session AND vtex_segment` was added to the API
- **2023-03-06** `37d29cfb77a1` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/vtex/apis/session-manager-api/changes/api/segments/get.md)

---

[API](https://skmtc.dev/vtex/apis/session-manager-api.md) · [All operations](https://skmtc.dev/vtex/apis/session-manager-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/session-manager-api/revisions/f4f1f2686364/schema)