Skip to main content
GET
/
connectors
/
{connectorId}
/
credentials
/
metadata
Get Connector Credentials Metadata
curl --request GET \
  --url https://production.runalloy.com/connectors/{connectorId}/credentials/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'
{
  "metadata": [
    {
      "authenticationType": "oauth2",
      "authConfigRequired": false,
      "inputSchema": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "User ID of the credential"
          },
          "authenticationType": {
            "type": "string",
            "description": "Type of authentication method of the connector",
            "const": "oauth2"
          },
          "redirectUri": {
            "type": "string",
            "format": "uri",
            "description": "Redirect URI for OAuth authentication"
          }
        },
        "required": [
          "userId",
          "authenticationType",
          "redirectUri"
        ]
      },
      "sampleInput": {
        "userId": "68fe36549000cce448466858",
        "authenticationType": "oauth2",
        "redirectUri": "https://example.com"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2025-09
required

API version

x-alloy-userid
string

The ID of the user making the request; If not provided, the request will be made as the API Key user

Path Parameters

connectorId
string
required

Connector ID

Response

200 - application/json

List of credentials metadata

metadata
object[]