Get Segment List

get-api2-segment-list

Get Segment List

Pulls a list of segments available and/or defined on Punchh, allowing for browsing/selecting of Punchh segments natively in an external platform. Segment search is on a business level, and the request can:

Set search limits and order by desc search
Search based on name or segment type filter
Filter based on name or description For more information, see Headless Offers Management - Distribution

Headers

Content-Type
Type: string
required

application/json
Accept
Type: string
required

application/json
Authorization
Type: string
required

Bearer token for admin authorization, who is making a call on behalf of the customer

Body

application/json

page
Type: integer

Number of pages
per_page
Type: integer

Number of records per page
query
Type: string

Define the search string on the segment name

Responses

200
Type: object
description
Type: string

Description of the segment

membership_level
Type: string

Membership level of the user

name
Type: string

Name of the segment

segment_id
Type: integer

Unique ID of the segment

segment_type
Type: string

Type of the segment

user_type
Type: string

Type of the user
400
Type: object
422
Type: object

get/api2/dashboard/segments

Show Schema

{
  "segment_id": 1,
  "name": "string",
  "description": "string",
  "segment_type": "string",
  "user_type": "string",
  "membership_level": "string"
}

Success