Get account integration details

GET

/api/v1/account_integration/{account_integration_id}

const url = 'https://app.prefactorai.com/api/v1/account_integration/013xrzp12g3nqk8ns6jadrqmpgrjkeny';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.prefactorai.com/api/v1/account_integration/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>'

Authorizations

authorization

Parameters

Path Parameters

account_integration_id

required

AccountIntegration_Id

A valid account integration ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

idempotency_key

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

Responses

200

Success

application/json

object

details

required

AccountIntegration_Details

object

config

required

Versioned integration config. Secrets such as the Slack webhook URL are redacted.

object

key

additional properties

any

required

AccountIntegration_Id

A valid account integration ID

string

integration_type

required

Integration type key for this account

string

status

required

Whether this integration is active or paused

string

Allowed values: active paused

type

required

Type of resource (always ‘account_integration’)

string

Allowed values: account_integration

status

required

string

Allowed values: success

Example

{
  "details": {
    "config": {
      "_version": 1,
      "enabled_events": [
        "agent_created"
      ],
      "webhook_url": {
        "$sensitive": "string",
        "labels": [
          "authentication_and_secrets"
        ]
      }
    },
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "integration_type": "slack",
    "status": "active",
    "type": "account_integration"
  },
  "status": "success"
}

default

Error

application/json

One of:

object

code

required

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_state alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used temporarily_unavailable conflict

message

required

string

status

required

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}