Skip to main content
npayload is launching soon.
npayloadDocs
API ReferenceConnectors

Get connector details

GET/v1/connectors/{connectorId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key authentication. Keys are prefixed with environment:

  • npk_live_ for production
  • npk_test_ for testing/staging

In: header

Path Parameters

connectorId*string

Connector ID

Response Body

application/json

application/json

application/json

curl -X GET "https://api.npayload.com/v1/connectors/string"
{
  "id": "string",
  "name": "string",
  "description": "string",
  "category": "string",
  "icon": "string",
  "authType": "oauth2",
  "status": "available"
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

Was this page helpful?