{"openapi":"3.1.0","info":{"title":"Aligno API","version":"1.0.0","description":"The Aligno public API. Authenticate with an API key (Bearer). Powers the Zapier integration and any custom automations.","license":{"name":"Proprietary","url":"https://aligno.io/terms"}},"servers":[{"url":"https://aligno.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An Aligno API key (algn_live_…). Generate one in the dashboard under Integrations → Zapier."}},"schemas":{"Me":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":["string","null"]},"name":{"type":["string","null"]},"connected":{"type":"boolean","enum":[true]}},"required":["id","email","name","connected"]},"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]},"Comment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"content":{"type":"string"},"author_name":{"type":["string","null"]},"author_email":{"type":["string","null"]},"status":{"type":"string"},"resolved_at":{"type":["string","null"]},"resolved_by":{"type":["string","null"]},"out_of_scope":{"type":"boolean"},"out_of_scope_note":{"type":["string","null"]},"is_reply":{"type":"boolean"},"page_number":{"type":["number","null"]},"position_x":{"type":["number","null"]},"position_y":{"type":["number","null"]},"shape":{"type":"string","enum":["pin","box","arrow","freehand"]},"project_id":{"type":"string","format":"uuid"},"project_name":{"type":"string"},"asset_id":{"type":"string","format":"uuid"},"asset_name":{"type":"string"},"dashboard_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id","content","author_name","author_email","status","resolved_at","resolved_by","out_of_scope","out_of_scope_note","is_reply","page_number","position_x","position_y","shape","project_id","project_name","asset_id","asset_name","dashboard_url","created_at"]},"Approval":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string"},"reviewer_name":{"type":["string","null"]},"reviewer_email":{"type":["string","null"]},"message":{"type":["string","null"]},"approved_via":{"type":"string"},"project_id":{"type":"string","format":"uuid"},"project_name":{"type":"string"},"asset_id":{"type":"string","format":"uuid"},"asset_name":{"type":"string"},"dashboard_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id","status","reviewer_name","reviewer_email","message","approved_via","project_id","project_name","asset_id","asset_name","dashboard_url","created_at"]},"Project":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"is_archived":{"type":"boolean"},"dashboard_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","is_archived","dashboard_url","created_at"]},"CreateProjectBody":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200}},"required":["name"]},"Asset":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"},"is_shared":{"type":"boolean"},"share_url":{"type":"string"},"project_id":{"type":"string","format":"uuid"},"project_name":{"type":"string"},"dashboard_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id","name","type","url","is_shared","share_url","project_id","project_name","dashboard_url","created_at"]},"CreateAssetBody":{"type":"object","properties":{"project_id":{"type":"string","format":"uuid"},"url":{"type":"string","maxLength":2048,"format":"uri"},"name":{"type":"string","minLength":1,"maxLength":200},"review_instructions":{"type":["string","null"],"maxLength":2000}},"required":["project_id","url","name"]},"AssetDetail":{"allOf":[{"$ref":"#/components/schemas/Asset"},{"type":"object","properties":{"current_version_number":{"type":["number","null"]},"approval_status":{"type":["string","null"]},"opens":{"$ref":"#/components/schemas/AssetOpens"}},"required":["current_version_number","approval_status","opens"]}]},"AssetOpens":{"type":"object","properties":{"opened":{"type":"boolean"},"first_opened_at":{"type":["string","null"]},"last_opened_at":{"type":["string","null"]}},"required":["opened","first_opened_at","last_opened_at"]},"ShareAssetBody":{"type":"object","properties":{"is_shared":{"type":"boolean","default":true},"password":{"type":["string","null"],"minLength":1,"maxLength":200},"expires_at":{"type":["string","null"],"format":"date-time"},"comments_disabled":{"type":"boolean"},"review_due_at":{"type":["string","null"],"format":"date-time"},"review_due_tz":{"type":["string","null"],"minLength":1,"maxLength":64}}},"AssetVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"asset_id":{"type":"string","format":"uuid"},"asset_name":{"type":"string"},"version_number":{"type":"number"},"is_current":{"type":"boolean"},"project_id":{"type":"string","format":"uuid"},"project_name":{"type":"string"},"dashboard_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id","asset_id","asset_name","version_number","is_current","project_id","project_name","dashboard_url","created_at"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"event":{"type":"string"},"target_url":{"type":"string"},"created_at":{"type":"string"}},"required":["id","event","target_url","created_at"]},"CreatedSubscription":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"CreateSubscriptionBody":{"type":"object","properties":{"event":{"type":"string","enum":["comment","approval","asset_created","asset_version_created","comment_resolved","project_created"]},"target_url":{"type":"string","format":"uri"}},"required":["event","target_url"]},"OkResponse":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]}},"required":["ok"]}},"parameters":{}},"paths":{"/api/v1/me":{"get":{"operationId":"getMe","summary":"Verify the API key and return the owner's identity.","tags":["Auth"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The authenticated key owner","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/comments":{"get":{"operationId":"listComments","summary":"List the owner's comments. Backs the New Comment + Comment Resolved triggers and the Find Comments search.","tags":["Comments"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"date-time","description":"Only return rows created after this ISO-8601 timestamp."},"required":false,"description":"Only return rows created after this ISO-8601 timestamp.","name":"since","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Max rows to return (1–100, default 50)."},"required":false,"description":"Max rows to return (1–100, default 50).","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Scope to one asset."},"required":false,"description":"Scope to one asset.","name":"asset_id","in":"query"},{"schema":{"type":"string","enum":["open","resolved"]},"required":false,"name":"status","in":"query"}],"responses":{"200":{"description":"Comments, newest first","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/approvals":{"get":{"operationId":"listApprovals","summary":"List the owner's decided approvals (approved / changes_requested). Backs the Approval Received trigger.","tags":["Approvals"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"date-time","description":"Only return rows created after this ISO-8601 timestamp."},"required":false,"description":"Only return rows created after this ISO-8601 timestamp.","name":"since","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Max rows to return (1–100, default 50)."},"required":false,"description":"Max rows to return (1–100, default 50).","name":"limit","in":"query"}],"responses":{"200":{"description":"Approvals, newest first","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/projects":{"get":{"operationId":"listProjects","summary":"List or search the owner's projects. Backs the New Project trigger and Find Project search.","tags":["Projects"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"date-time","description":"Only return rows created after this ISO-8601 timestamp."},"required":false,"description":"Only return rows created after this ISO-8601 timestamp.","name":"since","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Max rows to return (1–100, default 50)."},"required":false,"description":"Max rows to return (1–100, default 50).","name":"limit","in":"query"},{"schema":{"type":"string","description":"Partial name match."},"required":false,"description":"Partial name match.","name":"name","in":"query"}],"responses":{"200":{"description":"Projects, newest first","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createProject","summary":"Create a project.","tags":["Projects"],"security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectBody"}}}},"responses":{"201":{"description":"The created project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Invalid body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/assets":{"get":{"operationId":"listAssets","summary":"List or search the owner's assets. Backs the New Asset trigger and Find Asset search.","tags":["Assets"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"date-time","description":"Only return rows created after this ISO-8601 timestamp."},"required":false,"description":"Only return rows created after this ISO-8601 timestamp.","name":"since","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Max rows to return (1–100, default 50)."},"required":false,"description":"Max rows to return (1–100, default 50).","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"project_id","in":"query"},{"schema":{"type":"string","description":"Partial name match."},"required":false,"description":"Partial name match.","name":"name","in":"query"}],"responses":{"200":{"description":"Assets, newest first","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createAsset","summary":"Create a webpage asset from a URL.","tags":["Assets"],"security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetBody"}}}},"responses":{"201":{"description":"The created asset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}},"400":{"description":"Invalid body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Asset limit reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Project not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/assets/{id}":{"get":{"operationId":"getAsset","summary":"Get one asset incl. current version + latest approval. Backs the Find Asset Details search.","tags":["Assets"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"The asset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetDetail"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/assets/{id}/share":{"post":{"operationId":"shareAsset","summary":"Enable/configure the public review link for an asset.","tags":["Assets"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareAssetBody"}}}},"responses":{"200":{"description":"The updated asset incl. share_url","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}},"400":{"description":"Invalid body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/asset-versions":{"get":{"operationId":"listAssetVersions","summary":"List the owner's asset versions. Backs the New Asset Version trigger.","tags":["Assets"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","format":"date-time","description":"Only return rows created after this ISO-8601 timestamp."},"required":false,"description":"Only return rows created after this ISO-8601 timestamp.","name":"since","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Max rows to return (1–100, default 50)."},"required":false,"description":"Max rows to return (1–100, default 50).","name":"limit","in":"query"}],"responses":{"200":{"description":"Versions, newest first","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetVersion"}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/subscriptions":{"get":{"operationId":"listSubscriptions","summary":"List the owner's REST-hook subscriptions.","tags":["Subscriptions"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Subscriptions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createSubscription","summary":"Subscribe a hooks.zapier.com target to an event (Zapier performSubscribe).","tags":["Subscriptions"],"security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionBody"}}}},"responses":{"201":{"description":"The subscription id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedSubscription"}}}},"400":{"description":"Invalid event or target_url","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Too many subscriptions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/subscriptions/{id}":{"delete":{"operationId":"deleteSubscription","summary":"Unsubscribe a target (Zapier performUnsubscribe). Idempotent.","tags":["Subscriptions"],"security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OkResponse"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{}}