Sign in
Setup Package

List

Retrieve a paginated list of Setup Package records. Supports filtering, sorting, and search.

get/api/cp/setup/package

Query parameters

frequency'day' | 'week' | 'month' | 'pro_rata'

Filter by Frequency

visibility'Private' | 'Public'

Filter by Visibility

typestring

Filter by Type

Response

Successful response

idinteger

Id

account_idinteger

Account Id (references account.id)

company_idinteger

Company Id

namestring

Name

descriptionstring

Description

areastring

Area

qtynumber

Qty

retailnumber

Retail

costnumber

Cost

frequency'day' | 'week' | 'month' | 'pro_rata'

Frequency

frequency_matchstring

Frequency Match

destinationstring

Destination

visibility'Private' | 'Public'

Visibility

min_spendinteger

Min Spend

min_daysinteger

Min Days

setup_costnumber

Setup Cost

setup_retailnumber

Setup Retail

typestring[]

Type

cx_package_idinteger

Cx Package Id

Example response

[
  {
    "id": 12345,
    "account_id": 1,
    "company_id": 1,
    "name": "Example Name",
    "description": "A detailed description of the resource",
    "area": "example_area",
    "qty": 99.99,
    "retail": 99.99,
    "cost": 99.99,
    "frequency": "day",
    "frequency_match": "example_frequency_match",
    "destination": "example_destination",
    "visibility": "Private",
    "min_spend": 1,
    "min_days": 123,
    "setup_cost": 99.99,
    "setup_retail": 99.99,
    "type": "free-minutes",
    "cx_package_id": 1
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.