List Fields for Operation

GET 
/metadata/fields

Returns the list of fields available for a given operation. Commonly used to render a field mapping interface.

Request

Query Parameters

app stringrequired

Name of the app you want to list metadata for

operation stringrequired

The specified apps operation you would like to return the schema for.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

any

Result

{
   "queryParameters": [
     {
         "name": "firstName",
         "type": "string",
         "description": "First Name of the customer",
         "required": true
     },
     {
         "name": "lastName",
         "type": "string",
         "description": "Last Name of the customer",
         "required": true
     },
     {
         "name": "email",
         "type": "string",
         "description": "Email of the customer",
         "required": true
     },
     {
         "name": "phone",
         "type": "string",
         "description": "Phone of the customer",
         "required": false
     },
   ],
   "bodyParameters": []
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...