Skip to main content
GET
/
v3
/
integrations
List Integrations
curl --request GET \
  --url https://app.plugchoice.com/api/v3/integrations \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "logo_path": "<string>",
  "onboarding_url": "<string>",
  "marketing_url": "<string>",
  "config": {
    "commission_percentage": 123,
    "payout_frequency": "<string>",
    "contract_duration_months": 123,
    "automatic_renewal": true
  },
  "uses_oauth": true,
  "connected": true,
  "connected_since": "<string>"
}
Returns a list of active integrations. Each integration includes the connection status for the authenticated user.
type
string
Filter integrations by type. Currently supported: ere.

Response

id
integer
The numeric ID of the integration.
type
string
The integration type (e.g. ere).
name
string
The name of the integration.
description
string
A description of the integration. May be null.
logo_path
string
Path to the integration’s logo. May be null.
onboarding_url
string
The URL to start the OAuth onboarding flow. May be null.
marketing_url
string
A link to the integration’s public marketing or information page. May be null.
config
object
Integration-specific configuration.
uses_oauth
boolean
Whether the integration uses OAuth for automatic connection (true) or requires manual setup (false).
connected
boolean
Whether the authenticated user is currently connected to this integration.
connected_since
string
ISO 8601 timestamp of when the user first connected. null if not connected.