Segments

Get a segment

Get one segment in the tenant and project derived from the access token.

Overview

Use this endpoint to retrieve a single segment by ID. Archived segments are still returned and represented with status ARCHIVED. Filter version history is returned in descending version order, and internal actor IDs from BAU filter history are not exposed. It requires public api oauth access token authentication and the crm.segments.read scope.

GET/api/segments/{segmentId}

cURL

GET

bash

curl --request GET \  --url 'https://crm.notifyy.io/api/segments/999' \  --header 'Authorization: Bearer nfy_public_api_access_token' \  --header 'Accept: application/json'

Authorization

Public API OAuth access token

crm.segments.read

Sample Request Body

This endpoint does not require a request body.

Sample Response

json

{  "success": true,  "message": "Segment retrieved successfully",  "data": {    "id": 999,    "name": "High value contacts",    "objectType": "contact",    "segmentType": "ACTIVE",    "status": "ACTIVE",    "description": "Segment for high intent contacts",    "currentVersion": 2,    "filterVersions": [      {        "version": 2,        "filters": {          "logic": "AND",          "groups": [            {              "logic": "AND",              "filters": [                {                  "propertyId": 101,                  "property": "lifecyclestage",                  "operator": "equals",                  "value": "customer"                }              ]            }          ]        },        "createdAt": "2026-08-01T09:15:30Z",        "isCurrent": true      }    ],    "createdAt": "2026-08-01T09:15:30Z",    "updatedAt": "2026-08-01T10:15:30Z"  }}

Status Codes

Code	Description
200	Segment was returned.
401	Public API access token is missing, invalid, expired, or revoked.
404	Segment was not found in the token-bound tenant and project.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

AcceptstringRequired

Expected response media type.

Example: application/json

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token
Accept string	RequiredExpected response media type. Example: application/json

Path parameters

segmentIdintegerRequired

Segment identifier. It must belong to the token-bound tenant and project.

Example: 999

Object	Description
segmentId integer	RequiredSegment identifier. It must belong to the token-bound tenant and project. Example: 999

Detail Response Fields

Field

Type

integer

Description

Segment identifier.

Field

name

Type

string

Description

Segment name.

Field

objectType

Type

string

Description

Lowercase CRM object type.

Field

segmentType

Type

string

Description

Stored segment type such as ACTIVE or STATIC.

Field

status

Type

string

Description

Derived lifecycle state: ACTIVE or ARCHIVED.

Field

description

Type

string

Description

Segment description.

Field

currentVersion

Type

integer

Description

Current segment filter version.

Field

filterVersions

Type

array

Description

Filter version history ordered by version descending.

Field

filterVersions[].version

Type

integer

Description

Filter version number.

Field

filterVersions[].filters

Type

object

Description

Segment filter payload for that version.

Field

filterVersions[].createdAt

Type

datetime

Description

Filter version creation timestamp.

Field

filterVersions[].isCurrent

Type

boolean

Description

Whether the version matches currentVersion.

Field

createdAt

Type

datetime

Description

Segment creation timestamp.

Field

updatedAt

Type

datetime

Description

Segment update timestamp.

Field	Type	Description
id	integer	Segment identifier.
name	string	Segment name.
objectType	string	Lowercase CRM object type.
segmentType	string	Stored segment type such as ACTIVE or STATIC.
status	string	Derived lifecycle state: ACTIVE or ARCHIVED.
description	string	Segment description.
currentVersion	integer	Current segment filter version.
filterVersions	array	Filter version history ordered by version descending.
filterVersions[].version	integer	Filter version number.
filterVersions[].filters	object	Segment filter payload for that version.
filterVersions[].createdAt	datetime	Filter version creation timestamp.
filterVersions[].isCurrent	boolean	Whether the version matches currentVersion.
createdAt	datetime	Segment creation timestamp.
updatedAt	datetime	Segment update timestamp.

Response fields

successboolean

Whether the request succeeded.

Example: true

messagestring

Human-readable result message.

Example: Segment retrieved successfully

data.idinteger

Segment identifier.

Example: 999

data.filterVersionsobject[]

Filter version history ordered by version descending.

Object	Description
success boolean	Whether the request succeeded. Example: true
message string	Human-readable result message. Example: Segment retrieved successfully
data.id integer	Segment identifier. Example: 999
data.filterVersions object[]	Filter version history ordered by version descending.