Connection Model

id string

The unique identifier of the connection.

---

name string

The name of the connection

---

serviceId string

The ID of the service this connection belongs to.

---

unifiedApi string

The unified API category where the connection belongs to.

---

consumer string

---

enabled boolean

Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.

---

state string

---

Connection settings.

---

authorizeUrl string

The OAuth redirect URI. Redirect your users to this URI to let them authorize your app in the connector's UI. Before you can use this URI, you must add redirect_uri as a query parameter to the authorize_url. Be sure to URL encode the redirect_uri part. Your users will be redirected to this redirect_uri after they granted access to your app in the connector's UI.

---

{
  "id": "65bc598f70f3d226312887a1",
  "consumerId": "65bc598d6ffc3c44197747d2",
  "serviceId": "bamboohr",
  "unifiedApi": "hris",
  "name": "BambooHR",
  "state": "available",
  "enabled": true,
  "settings": {},
  "metadata": {},
  "authorizeUrl": null
}