Skip to main content
GET
Get the write schema for a push action

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

id
integer
required

App integration account ID.

Query Parameters

action
enum<string>
required

The push action to describe. Only PUSH_PRODUCTS is currently supported.

Available options:
PUSH_PRODUCTS
refresh
boolean
default:true

When true (default), fetches the latest schema live from the integration; false uses the cached copy.

Response

Successful response

data
object