Docs
V2 APIConnections

List connections

GET/api/v2/connections

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
per_page?integer
Range1 <= value <= 200
Default15
property_id?string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/connections"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "category": "string",      "name": "string",      "enabled": true,      "pricing_includes_fees": true,      "settings": {},      "properties": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "settings": {}        }      ],      "latest_log": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "event_type": "string",        "status": "string",        "message": "string",        "duration": 0,        "created_at": "2019-08-24T14:15:22Z"      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "page": 0,        "active": true      }    ],    "path": "string",    "per_page": 200,    "to": 0,    "total": 0  }}