dashboard_list_all_custom_segments

List All Custom Segments

​

Returns a list of all custom segments created by a business

Headers
  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

Responses
  • 200
    Type: array object[]
    • created_at
      Type: string

      Date/time when the custom segment was created in the system, in ISO 8601 format

    • custom_segment_id
      Type: integer

      Unique ID of a custom segment. This is generated by Punchh.

    • description
      Type: string

      Description of the custom segment as given by the admin user when creating the custom segment

    • name
      Type: string

      Name of the custom segment as given by the admin user when creating the custom segment

    • updated_at
      Type: string

      Date/time when the custom segment was last updated in the system, in ISO 8601 format

  • 401
    Type: object
    • error
      Type: string
get/api2/dashboard/custom_segments
[
  {
    "custom_segment_id": 1,
    "name": "string",
    "description": "string",
    "created_at": "string",
    "updated_at": "string"
  }
]