Retrieve credential structure for an app

GET 
/metadata/credentials/:app

Request

Path Parameters

app stringrequired

Name of App (camelCased, can be found in App Metadata response)

Header Parameters

Authorization string

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

data

object

name string

icon string

isOauth boolean

Default value: true

properties

object[]

Array [

name string

displayName string

description string

]

Example (from schema)

{
  "data": {
    "name": "shopify",
    "icon": "https://cdn.runalloy.com/icons/shopify.png",
    "isOauth": true,
    "properties": [
      {
        "name": "shopSubdomain",
        "displayName": "Shop Subdomain",
        "description": "Enter your store subdomain. If your store domain is example.myshopify.com, the subdomain would be example."
      }
    ]
  }
}

Result

{
  "data": {
    "name": "shopify",
    "icon": "https://cdn.runalloy.com/icons/shopify.png",
    "isOauth": true,
    "properties": [
      {
        "name": "shopSubdomain",
        "displayName": "Shop Subdomain",
        "description": "Enter your store subdomain. If your store domain is example.myshopify.com, the subdomain would be example."
      }
    ]
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...