Skip to main content
GET
/
businesses
/
{id}
/
segments
List all the business's segments
curl --request GET \
  --url https://api.pocketflows.com/businesses/{id}/segments \
  --header 'Authorization: Basic <encoded-value>'
{
  "segments": [
    {
      "id": "<string>",
      "name": "<string>",
      "filter": "<string>",
      "description": "<string>",
      "static_customers": [
        "<string>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.pocketflows.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Response

200 - application/json

A dictionary with a segments property which is an array of Segment objects

​
segments
The Segment object · object[]
required

An array of segments