Admin API
Last updated
Was this helpful?
Last updated
Was this helpful?
The MESA Admin API allows you to programmatically interact with MESA. All requests must include your API key which can be found in My Account > Credentials.
{url}
https://api.getmesa.com/v1
{uuid}
Your store’s unique identifier: {{uuid}}.myshopify.com
Returns a list of all Credential names. Credential values are not available via the Admin API.
{{api_key}}Successful response
No content
new_workflow_1googlesheets_1{{api_key}}Successful response
No content
Note: Storage has been deprecated in favor of Data by MESA. Returns a list of all Storage item names. To get a Storage value, call GET {{url}}/admin/{{uuid}}/storage/{{storage_name}}.json
new_workflow_1{{api_key}}Successful response
No content
Note: Storage has been deprecated in favor of Data by MESA.
new_workflow_1storage_1{{api_key}}Successful response
No content
Note: Storage has been deprecated in favor of Data by MESA. Delete a Storage item.
new_workflow_1storage_1{{api_key}}Successful response
No content
Restart the execution of the workflow from a specific task. Data from all steps previous to this task in the original workflow run will be available.
To find the Task ID, click on a step in the Activity List > Request Details, and copy the last ID hash from the URL
65f3459357ca4e809608c8fb{{api_key}}Successful response
No content
Returns a list of automations for a store, sorted by most recently created first.
{{api_key}}{"automations":[{"uuid":"my-store","created_by":"","key":"etsy_order_send_to_google_sheets","name":"Send Etsy orders to Google Sheets","version":"1.0.0","template":"etsy/order/send_to_google_sheets","description":"Consolidate your Etsy orders in Google Sheets for real-time tracking and improved order management. This template will automatically send Etsy order details to a Google Sheets spreadsheet when a customer completes an order on Etsy.","video":"","is_premium":false,"tags":[],"source":"","destination":"","enabled":false,"did_complete":false,"logging":true,"debug":false,"setup":"incomplete","seconds":135,"notifications":{"enabled":false,"emails":["example@theshoppad.com"]},"_id":"65f1fdbbb54ac273e806026b","created_at":"Mar 13 2020","updated_at":"Mar 13 2024"}]}Successful response
No content
Updates the Inputs, Outputs, Credentials and Storage for an automation. Updating scripts requires separate calls to the Script POST endpoing for each script.
{{api_key}}{"key":"","name":"","config":{"inputs":[],"outputs":[],"secrets":[],"storage":[],"files":[],"overwrite":false}}Successful response
No content
new_workflow_1{{api_key}}{"secret":{"key":"mysecret","value":"myvalue"}}Successful response
No content
new_workflow_1{{api_key}}{"secret":{"value":"myvalue"}}Successful response
No content
Note: Storage has been deprecated in favor of Data by MESA. Value parameter can be a string, an object, an array, or a boolean value.
new_workflow_1{{api_key}}{"storage":{"key":"{{storage_key}}","value":{"mykey":"myvalue"}}}Successful response
No content
Note: Storage has been deprecated in favor of Data by MESA. Value parameter can be a string, an object, an array, or a boolean value.
new_workflow_1storage_1{{api_key}}{"storage":{"value":"mynewstringvalue"}}Successful response
No content
new_workflow_1{{api_key}}{"script":{"filename":"myscript.js","code":"// Javascript goes here"}}Successful response
No content
Trigger a test with a specific that is passed as the payload body parameter. To test an actual payload, consider running a test in the UI and replaying the task with POST replay.json.
new_workflow_1shopify_1{{api_key}}{"payload":{}}Successful response
No content
{{api_key}}{"template":"shoppad/mesa-templates/tests/kitchen-sink","force":true}Successful response
No content