COconnexcs
Setup Voucher

List

Changed on

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

get/api/cp/cx-voucher

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

Query parameters

state'Active' | 'Inactive' | 'Used'

Filter by State

Response

Successful response

idinteger

Id

codestring

Code

account_idinteger

Account Id

end_datestring date-time

End Date

state'Active' | 'Inactive' | 'Used'

State

descriptionstring

Description

min_activationnumber

Min Activation

multipliernumber

Multiplier

additionnumber

Addition

used_by_account_idinteger

Used By Account Id

use_onceinteger

Use Once

min_per_minute_ratenumber

Min Per Minute Rate

Example response

[
  {
    "id": 12345,
    "code": "example_code",
    "account_id": 1,
    "end_date": "2025-01-17T10:30:00Z",
    "state": "Active",
    "description": "A detailed description of the resource",
    "min_activation": 99.99,
    "multiplier": 99.99,
    "addition": 99.99,
    "used_by_account_id": 1,
    "use_once": 1,
    "min_per_minute_rate": 99.99
  }
]

Changes