COconnexcs
Setup Package

Read

Changed on

Retrieve a single Setup Package record by ID.

get/api/cp/setup/package/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

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

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API