> ## Documentation Index > Fetch the complete documentation index at: https://docs.vortexiq.ai/llms.txt > Use this file to discover all available pages before exploring further. # List stores > What an automation can run on: your organisation's connected stores, and the accounts some templates run on instead, such as a cloud account. Each has the `integration_id` you pass when you [create an automation](/automations/api/create-automation), its platform, and the timezone its automations run in unless you choose another. Stores are connected in the Vortex IQ app (**Settings**, **Connected Sources**), never through this API. Needs the `automations:read` scope. ## OpenAPI ````yaml automations/api/openapi.json GET /v1/automations/stores openapi: 3.1.0 info: title: Vortex IQ Automations API version: 1.0.0 description: > REST API for Vortex IQ Automations. List the templates your organisation can use, set automations up on your stores, schedule them, run them, and follow every run, from your own tools instead of the Automations screens. The API is served from `https://automations-api.vortexiq.ai`; the login that gives you a token is on `https://app.vortexiq.ai`. Every call acts as the person who logged in, within their organisation, and every answer is JSON. See [Authentication](/automations/api/authentication). contact: name: Vortex IQ Support url: https://www.vortexiq.ai/contact-us servers: - url: https://automations-api.vortexiq.ai description: Vortex IQ Automations (production) security: - bearerAuth: [] - apiCredential: [] tags: - name: Authentication description: >- Exchange your identity and your organisation's API credential for a bearer token. - name: Templates & stores description: What you can set up, and what it can run on. - name: Automations description: Set automations up, read them and change them. - name: Automation controls description: Pause, resume, archive and restore. - name: Runs description: Run an automation now, follow a run, read the history. - name: Schedules & calendar description: Preview a schedule, list the coming runs, move or skip one. - name: Approvals description: >- The runs waiting for a decision. Deciding happens in the Vortex IQ app only. - name: Imported workflows description: >- Bring an n8n or Shopify Flow workflow in, see how it would run, and run it as your own automation. - name: Status description: >- Whether Automations are on for your organisation, and how the service is doing. paths: /v1/automations/stores: get: tags: - Templates & stores summary: List stores description: >- What an automation can run on: your organisation's connected stores, and the accounts some templates run on instead, such as a cloud account. Each has the `integration_id` you pass when you [create an automation](/automations/api/create-automation), its platform, and the timezone its automations run in unless you choose another. Stores are connected in the Vortex IQ app (**Settings**, **Connected Sources**), never through this API. Needs the `automations:read` scope. operationId: listStores responses: '200': description: >- Your organisation's stores and accounts, connected ones first, then by name. content: application/json: schema: type: object required: - success - data - contract_version properties: success: type: boolean const: true contract_version: $ref: '#/components/schemas/ContractVersion' data: type: object required: - stores properties: stores: type: array items: $ref: '#/components/schemas/Store' example: success: true contract_version: 1 data: stores: - integration_id: 101 platform: shopify label: Example Shopify store timezone: Europe/London state: connected handed_over_at: '2026-10-13T10:15:19.830Z' - integration_id: 41 platform: aws label: Example AWS account timezone: Europe/London state: connected handed_over_at: '2026-10-13T10:15:19.830Z' '401': $ref: '#/components/responses/Unauthorised' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' security: - bearerAuth: - automations:read - apiCredential: - automations:read components: schemas: ContractVersion: type: integer minimum: 1 description: >- The version of the API this answer follows. It changes only for a breaking change. Store: type: object description: >- What an automation can run on: a store, or an account a template runs on, such as a cloud account. Never its keys. required: - integration_id - platform - label - timezone - state - handed_over_at properties: integration_id: type: integer minimum: 1 description: >- The id of the store or account, which you pass as `integration_id` when you create an automation. platform: $ref: '#/components/schemas/Platform' label: type: string timezone: type: string description: >- The timezone (IANA name) a new automation on this store runs in unless you choose another. state: type: string enum: - connected - disconnected description: >- `connected`, or `disconnected`: a disconnected store is listed so you can see why an automation on it cannot run, and is never one to set a new automation up on. handed_over_at: $ref: '#/components/schemas/Timestamp' description: >- When Vortex IQ last received this store's connection, as it was made or changed in the Vortex IQ app. Platform: type: string pattern: ^[a-z][a-z0-9_]{1,63}$ description: >- What an automation runs on: a store's platform (`shopify`, `bigcommerce`), or an account a template runs on, such as a cloud account (`aws`). example: shopify Timestamp: type: string format: date-time description: A time in UTC (ISO 8601). ErrorResponse: type: object required: - success - message - contract_version properties: success: type: boolean const: false contract_version: $ref: '#/components/schemas/ContractVersion' message: type: string description: Plain words saying what happened and what to do. code: type: string description: >- A stable code to act on, such as `wrong_state`, `stale_version` or `allowance_spent`. errors: type: object description: Field name to messages, for 422. additionalProperties: type: array items: type: string responses: Unauthorised: description: >- The token is missing, has expired, or is no longer valid (for example, the API credential was rotated or disabled). The answer carries `WWW-Authenticate`; log in again for a new token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Your token is valid but may not do this: it lacks the scope, the operation is not part of the Automations API, or Automations are switched off for your organisation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' TooManyRequests: description: >- Too many calls in a minute from you or your organisation; nothing was done. `Retry-After` says how many seconds to wait. headers: Retry-After: schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- A bearer token from [Login](/automations/api/login), sent as `Authorization: Bearer `. Valid for 60 minutes; it acts as the person named at login, within their organisation, and never approves. Rotating or disabling the organisation's API credential ends every token made with it on its next call. See [Authentication](/automations/api/authentication). apiCredential: type: oauth2 description: >- Your organisation's API credential, exchanged at [Login](/automations/api/login) for the bearer token above: an OAuth 2.0 client-credentials request, with the `username`, `email` and `organization_name` of the person the token acts as sent as extra fields, as Postman's OAuth 2.0 helper can send them. The token never holds `automations:approve`. flows: clientCredentials: tokenUrl: https://app.vortexiq.ai/v2/api/automations/login scopes: automations:read: >- Read automations, templates, stores, runs, the calendar, approvals and imports. automations:write: >- Set automations up, change, pause, resume, archive, restore and run them; move and skip coming runs; keep and delete imports. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.