Skip to main content
GET
/
api
/
v2
/
public
/
auth-structure
/
:slug
curl -X GET "https://app.refold.ai/api/v2/public/auth-structure/{slug}"
{
  "oauth2": {
    "access_token": "string",
    "refresh_token": "string",
    "client_id": "string",
    "client_secret": "string",
    "callback_url": { "type": "string", "required": false }
  }
}
Return a flat description of the auth fields required for each of an app’s supported auth types (oauth2, keybased, …). Use this to build a credential-entry form dynamically, or to know exactly which fields to send to Save Key Credentials or Migrate Token. Each field’s value is either a type string (e.g. "string") or an object {type, required: false} for optional fields.
This route has no authentication — no API key or session token is required.

Path Parameters

slug
string
required
The app slug.Example: hubspot, netsuite

Response

An object keyed by auth type. Each auth type maps to its field definitions, where a value is either a type string or {type, required} for optional fields.
{
  "oauth2": {
    "access_token": "string",
    "refresh_token": "string",
    "client_id": "string",
    "client_secret": "string",
    "callback_url": { "type": "string", "required": false }
  }
}
curl -X GET "https://app.refold.ai/api/v2/public/auth-structure/{slug}"