COconnexcs
Setup Vars

Read

Changed on

Retrieve a single Setup Vars record by ID.

get/api/cp/setup/var/{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

idstring

Id

account_idinteger

Account Id

app_idstring

App Id (references app.id)

keystring

Key

valuestring

Value

key_namestring

Key Name

last_updatestring date-time nullable

Last Update

flagsstring[]

Flags

Example response

{
  "id": 12345,
  "account_id": 1,
  "app_id": 1,
  "key": "example_key",
  "value": "Sample value text content",
  "key_name": "example_key_name",
  "last_update": "2025-01-17T10:30:00Z",
  "flags": "protected"
}

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