> ## Documentation Index > Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt > Use this file to discover all available pages before exploring further. # Get an automation > Returns a single automation by ID. ## OpenAPI ````yaml /api-reference/rest-api-v4.yaml get /automations/{automation_id} openapi: 3.0.3 info: title: Qonversion REST API v4 version: '4.0' description: >- Qonversion REST API v4 follows REST standards. It has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. servers: - url: https://api.qonversion.io/v4 description: Production security: - secretAuth: [] tags: - name: Users description: Retrieve Qonversion users - name: User Properties description: Manage user-level attributes - name: Identities description: Link Qonversion users to your own auth IDs - name: Entitlements description: Entitlement definitions and user grants - name: Purchases description: A user's purchase history - name: Products description: Products configured in the Qonversion dashboard - name: Customers description: Aggregated customer records, properties, permissions, and metrics - name: Segments description: Dynamic and system segments of users - name: Experiments description: Paywall and offering A/B experiments - name: Screens description: No-code paywall screens — CRUD, publish, analytics - name: Analytics description: Charts, cards, cohorts, LTV, and insights - name: Exports description: Asynchronous data exports - name: Events description: Event catalog - name: Scheduled Reports description: Recurring reports delivered to external destinations - name: Integrations description: Third-party integrations configuration - name: Automations description: Event-driven automations - name: Project Settings description: Project-level configuration, secret, and store credentials paths: /automations/{automation_id}: get: tags: - Automations summary: Get an automation description: Returns a single automation by ID. operationId: v4GetAutomation parameters: - name: automation_id in: path required: true description: Automation identifier. schema: type: string pattern: ^[a-zA-Z0-9._-]+$ maxLength: 256 example: auto-abc123 responses: '200': description: Automation details. headers: Cache-Control: schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/V4Automation' '400': description: Invalid automation_id content: application/json: schema: $ref: '#/components/schemas/V4Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/V4Error' '403': description: Feature not available content: application/json: schema: $ref: '#/components/schemas/V4Error' '404': description: Automation not found content: application/json: schema: $ref: '#/components/schemas/V4Error' '429': description: Rate limit exceeded headers: Retry-After: schema: type: integer description: Seconds to wait before retrying content: application/json: schema: $ref: '#/components/schemas/V4Error' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/V4Error' '502': description: Upstream service failure content: application/json: schema: $ref: '#/components/schemas/V4Error' '504': description: Upstream timeout content: application/json: schema: $ref: '#/components/schemas/V4Error' security: - secretAuth: [] components: schemas: V4Automation: type: object required: - object - id - url - name - caption - status - data properties: object: type: string enum: - automation description: Always "automation". id: type: string description: Unique automation identifier. example: auto-abc123 url: type: string description: Canonical API path for this automation. example: /v4/automations/auto-abc123 name: type: string description: Human-readable name of the automation. example: Welcome Flow caption: type: string description: Optional description of the automation. example: Sends a welcome message to new users status: type: string description: | Lifecycle status of the automation. `paused` is set via `PATCH /automations/{id}/status` to temporarily stop an active automation without deleting it. `unknown` is returned as a forward-compatibility fallback and should not be written. x-extensible-enum: - active - inactive - paused - unknown example: active data: $ref: '#/components/schemas/V4AutomationData' V4Error: type: object required: - error properties: error: type: object required: - type - code - message properties: type: type: string enum: - request - resource - logical - internal code: type: string description: | Machine-readable snake_case error code. Examples include `invalid_data`, `invalid_request`, `invalid_product_id`, `not_found`, `already_exists`, `offering_already_exists`, `product_not_in_project`, `cannot_set_main_directly`, `cannot_demote_main`, `cannot_patch_experiment_variant`, `cannot_delete_experiment_variant`, and `cannot_setmain_experiment_variant`. Resource-specific codes are documented on the corresponding reference page. message: type: string description: Human-readable description. May change; do not parse. details: type: array nullable: true description: Per-field validation errors, present on 400 validation failures. items: type: object properties: field: type: string message: type: string V4AutomationData: type: object required: - initiators - actions - segments description: | Automation configuration. Push and event resources are dashboard-only; this object references them by uid. properties: type: type: string nullable: true description: Derived on read from initiator types. Ignored on write. x-extensible-enum: - event example: event platform: type: string nullable: true description: Platform filter for the automation. `null` for all platforms. enum: - iOS - Android - null example: iOS initiators: type: array minItems: 1 description: One or more event initiators that trigger the automation. items: type: object required: - uid - type properties: uid: type: string description: Dashboard event id (numeric string). example: '2' type: type: string enum: - event example: event actions: type: object description: >- Actions to perform when the automation fires. At least one of `push` or `screen` must be present. properties: push: type: string nullable: true description: Push notification uid (created in the dashboard). example: nCRUE7SW screen: type: string nullable: true description: Screen uid (see `/v4/screens`). example: qUY7JXgF segments: type: string nullable: true description: Segment uid to target; `null` runs for all users. example: A0SzRbM2vmmwixbpQxtI securitySchemes: secretAuth: type: http scheme: bearer bearerFormat: sk_… description: >- Bearer authentication using the project **Secret Key** (prefixed with `sk_`, or `test_sk_` for sandbox). All v4 public endpoints require the Secret Key — see [Authentication](/reference/v4/authentication). Never expose the Secret Key in client-side code. ````