Actions67
- Addon Actions
- Door Lock Actions
- Event Actions
- Guest Actions
- Housekeeping Actions
- Integration Event Actions
- Item Actions
- Market Segmentation Actions
- Payment Actions
- Property Actions
- Rate Actions
- Reservation Actions
- Room Actions
- Webhook Actions
Market Segmentation → Get Segments
AI-generatedSummary
Get Segments
Inputs
- authentication — Authentication method to use for API requests. Defaults to access token if not specified.
- enabledOnly — When true, restricts results to only enabled segments. Defaults to true.
- returnAll — When false (default), results are capped by the limit parameter. When true, all available segments are returned.
- limit — Maximum number of segment records to return. Accepts values 1-100, default 50. Only applicable when returnAll is false.
Output shape
array of segment objects from Cloudbeds API
Exact return structure not documented in properties; consult Cloudbeds API specification for segment object schema.
Examples
Example 1: Fetch only enabled segments with default pagination
enabledOnly=true, returnAll=false (default), authentication=accessToken
Example 2: Retrieve all segments without limit
enabledOnly=true, returnAll=true, authentication=accessToken