Get all Toggles attached to a given Contract

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

id

integer

required

The ID of the contract

api-version

integer

required

Target API version

``200 Success

array of objects

object

id

integer

active

boolean \| null

Only present on Managed Toggles

text

string

The text of the toggle

numeric_order

integer

0 indexed position index for the toggle to print on contracts

language

string

The main language of the agreement

style

string \| null

Only present on Agreement Toggles (non-Managed toggles)

translations

string

this is text based attribute but will work as JSON format to handle sub-languages like fr

read_only

boolean

created_at

date-time

updated_at

date-time

``401 Unauthorized

``403 Forbidden

``404 Not found

``406 Not Acceptable

Updated3 months ago


ShellNodeRubyPHPPython

Bearer

Base URL

https://api.dealerware.com/admin/contracts/{id}/agreement/toggles


xxxxxxxxxx

curl --request GET \
 
     --url https://api.dealerware.com/admin/contracts/id/agreement/toggles \
 
     --header 'accept: application/json'

xxxxxxxxxx

[\
\
  {\
\
    "id": 123,\
\
    "active": true,\
\
    "text": "I agree to receive my contract and receipt communications via SMS",\
\
    "numeric_order": 1,\
\
    "language": "en",\
\
    "style": "bold",\
\
    "translations": [\
\
      {\
\
        "language": "fr",\
\
        "text": "French version of the text"\
\
      }\
\
    ],\
\
    "read_only": true,\
\
    "created_at": "2020-06-15T20:22:26Z",\
\
    "updated_at": "2020-06-15T20:22:26Z"\
\
  }\
\
]