This documentation is still a work in progress. Please contact Support to register for early access.

Get Connection Schema for Integration

GET

https://api.portierx.com/api/v1/integrations/catalog/{id}/connect

Returns the connection schema and onboarding instructions for a specific integration application. Clients use this information to render the connection UI and prepare the payload to submit.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.portierx.com/api/v1/integrations/catalog//connect' \
--header 'Authorization: <api-key>'

Response Example

{
    "msg": "string",
    "data": {
        "guide": "string",
        "form": {
            "schema": {},
            "ui": {},
            "initial_data": {}
        },
        "request_type": "json",
        "next_action_url": "string"
    }
}

Modified at 2025-11-16 19:41:07

Get Integration Application Details

List Integration Connections