admin api.md
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.
Admin API
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 > Connections.
| Key | Value |
|---|---|
| {url} | https://api.getmesa.com/v1 |
| {uuid} | Your store’s unique identifier: {{uuid}}.myshopify.com |
Workflows
Get Automations
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}
Get Automation
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations/{automation_key}.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}
Create Automation
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Delete Automation
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/automations/{automation_key}.json" method="delete" %} mesa-admin.openapi.json {% endopenapi %}
Connections
Get Credentials
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/credentials.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}
Create Credential
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/credentials.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Update Credential
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/credentials/{credential_key}.json" method="put" %} mesa-admin.openapi.json {% endopenapi %}
Delete Credential
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/credentials/{credential_key}.json" method="delete" %} mesa-admin.openapi.json {% endopenapi %}
Storage
Get Storage
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/storage.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}
Create Storage
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/storage.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Get Storage Item
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/storage/{storage_key}.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}
Update Storage Item
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/storage/{storage_key}.json" method="put" %} mesa-admin.openapi.json {% endopenapi %}
Delete Storage Item
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/storage/{storage_key}.json" method="delete" %} mesa-admin.openapi.json {% endopenapi %}
Scripts
Get Scripts
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/scripts.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}
Create Script
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/scripts.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Delete Script
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/scripts.json" method="delete" %} mesa-admin.openapi.json {% endopenapi %}
Testing
Test Trigger
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/{automation_key}/triggers/{trigger_key}/test.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Tasks
Replay Task
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/tasks/{task_id}/replay.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Templates
Install Template
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/templates/install.json" method="post" %} mesa-admin.openapi.json {% endopenapi %}
Logs
Get Logs
{% openapi src="/files/BHhUoo65NAL31c69geMn" path="/admin/{uuid}/logs.json" method="get" %} mesa-admin.openapi.json {% endopenapi %}