> ## Documentation Index > Fetch the complete documentation index at: https://docs.usereplier.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a Replier automation > Returns one automation's settings, its targets with their state, its status and issues, and its version. Read it before you update or delete. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/workspaces/{workspace_id}/automations/{automation_id} openapi: 3.1.0 info: title: Replier API version: '1' servers: - url: https://api.usereplier.com security: - apiKey: [] paths: /v1/workspaces/{workspace_id}/automations/{automation_id}: get: tags: - Automations summary: Get a Replier automation description: >- Returns one automation's settings, its targets with their state, its status and issues, and its version. Read it before you update or delete. operationId: get_automation parameters: - name: workspace_id in: path required: true description: Workspace ID returned by `GET /v1/workspaces` schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - name: automation_id in: path required: true schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ responses: '200': description: OK content: application/json: schema: type: object properties: workspace: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string kind: type: string enum: - personal - agency role: type: string enum: - owner - admin - member required: - id - name - kind - role automation: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ version: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 name: type: string enabled: description: >- The automation's own on/off switch. Whether it answers now is status. type: boolean status: description: >- live: on and at least one target answers now. not_live: on, but nothing answers; issues says why. paused: switched off with enabled false. type: string enum: - live - not_live - paused issues: description: >- Each reason something doesn't answer now, with what it means and what the user does. code is a target state other than active (see targets[].state, listed in target_ids), no_targets, workspace_paused or workspace_payment_overdue. A live automation can list issues for some of its targets. type: array items: type: object properties: code: type: string target_ids: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ since: description: >- For no_targets: when its last target was removed. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ required: - code paused: description: >- Only when status is paused: what turned it off, and when. type: object properties: by: description: >- person: someone in the workspace turned it off, or removed its last target. channel_disconnect: disconnecting its account's channel turned it off, and reconnecting turns it back on unless someone saved it since. unrecorded: Replier has no record of what turned it off. type: string enum: - person - channel_disconnect - unrecorded at: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' by_name: description: Who turned it off, when by is person. type: - string - 'null' required: - by - at - by_name keywords: type: array items: type: string public_reply_enabled: type: boolean public_replies: type: array items: type: string public_reply_selection: type: string enum: - random - round_robin dm_message: type: string dm_image: anyOf: - type: object properties: id: type: string url: type: string display: description: >- card: cropped per channel with the message as its title and the buttons on it. photo: sent at its original ratio, then the message (if any) with the buttons. default: card type: string enum: - card - photo required: - id - url - display - type: 'null' follow_gate_enabled: type: boolean follow_gate_message: type: string follow_gate_button_text: type: string follow_gate_retry_message: type: string follow_gate_retry_button_text: type: string follow_gate_profile_button_enabled: description: >- Whether the Follow Gate prompt and its reminder show a button that opens the Instagram account's profile. type: boolean follow_gate_profile_button_text: description: >- Null until the automation has its own label; turning the button on then needs one. type: - string - 'null' gates: description: >- Opening and email gates, in addition to Follow Gate. Set them with gates in `POST /v1/workspaces/{workspace_id}/automations` or `PATCH /v1/workspaces/{workspace_id}/automations/{automation_id}`. Runs waiting on any gate appear as gated. type: object properties: opening: description: >- The recipient must tap this button before the main DM is sent. anyOf: - type: object properties: message: type: string button_text: type: string required: - message - button_text - type: 'null' email: description: >- The recipient must reply with an email address before the main DM is sent. anyOf: - type: object properties: message: type: string retry_message: type: string required: - message - retry_message - type: 'null' required: - opening - email follow_up: description: >- Follow-up message after the DM, or null. Set it with follow_up in `POST /v1/workspaces/{workspace_id}/automations` or `PATCH /v1/workspaces/{workspace_id}/automations/{automation_id}`, which describes when each branch is sent. anyOf: - type: object properties: wait_hours: type: number clicked: type: object properties: message: type: string image: anyOf: - type: object properties: id: type: string url: type: string display: type: string required: - id - url - display - type: 'null' buttons: type: array items: type: object properties: title: type: string url: type: string required: - title - url enabled: type: boolean delay_minutes: type: number required: - message - image - buttons - enabled - delay_minutes not_clicked: type: object properties: message: type: string image: anyOf: - type: object properties: id: type: string url: type: string display: type: string required: - id - url - display - type: 'null' buttons: type: array items: type: object properties: title: type: string url: type: string required: - title - url enabled: type: boolean required: - message - image - buttons - enabled required: - wait_hours - clicked - not_clicked - type: 'null' buttons: type: array items: anyOf: - type: object properties: id: type: string title: type: string url: type: string required: - id - title - url - type: object properties: id: type: string title: type: string type: type: string const: postback message: description: Sent as a DM when the button is tapped. type: string required: - id - title - type - message flow: anyOf: - type: object properties: nodes: type: array items: type: object properties: id: type: string name: type: string message: type: string image: anyOf: - type: object properties: id: type: string url: type: string display: description: >- card: cropped per channel with the message as its title and the buttons on it. photo: sent at its original ratio, then the message (if any) with the buttons. default: card type: string enum: - card - photo required: - id - url - display - type: 'null' buttons: type: array items: oneOf: - type: object properties: type: type: string const: web_url id: type: string title: type: string url: type: string required: - type - id - title - url - type: object properties: type: type: string const: postback id: type: string title: type: string target_node_id: type: string required: - type - id - title - target_node_id required: - id - name - message - image - buttons keyword_routes: description: >- Branches after the automation's own keywords (branch 1), tried in order: the first branch with a keyword standing alone in a comment, story reply or message (else the first with a keyword inside a longer word) sends its entry node and public replies. type: array items: type: object properties: id: type: string keywords: type: array items: type: string entry_node_id: type: string public_reply_enabled: type: boolean public_replies: type: array items: type: string public_reply_selection: type: string enum: - random - round_robin required: - id - keywords - entry_node_id - public_reply_enabled - public_replies - public_reply_selection required: - nodes - type: 'null' targets: type: array items: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ channel: type: string enum: - instagram - facebook account_id: type: string account_name: description: >- The Instagram username or Facebook Page name. Null when the account is no longer connected to this workspace. type: - string - 'null' target_type: description: >- scheduled_post waits for a post Replier will publish and becomes post when it does. unchosen_post answers nothing until a post is chosen: any other comment target on the same account replaces it when saved, so send the new target without the unchosen_post. type: string enum: - post - next_post - all_future_posts - story_replies - story_mentions - next_story - story - message - scheduled_post - unchosen_post post_id: type: - string - 'null' scheduled_post_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' post_permalink: type: - string - 'null' post_label: type: - string - 'null' post_image_url: type: - string - 'null' activated_at: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' resolved_at: description: >- When a next_post, next_story or scheduled_post target took this post or story and became a post or story target. Null for a target chosen directly. anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' expires_at: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' resolution_source: anyOf: - type: string enum: - comment_webhook - story_reply_webhook - dashboard_refresh - scheduled_reconcile - publish - type: 'null' queue_position: description: >- For next_post, active or paused: which upcoming post it will use (1 = the next post). Null otherwise. anyOf: - type: integer exclusiveMinimum: 0 maximum: 9007199254740991 - type: 'null' state: description: >- Whether this target answers now. active: it does. waiting_for_next_post, waiting_for_next_story: it takes the account's next post or story. waiting_for_publish: it takes a post when Replier publishes it. waiting_for_post_choice: no post chosen yet, so it answers nothing. expired: the story or post is gone. account_not_subscribed: the account receives no comment or message events; the user retries auto-reply setup in Replier. account_needs_reconnect: Meta rejected the account's token; the user reconnects it in Replier. account_disconnected: the account is no longer connected to this workspace. type: string enum: - active - waiting_for_next_post - waiting_for_next_story - waiting_for_publish - waiting_for_post_choice - expired - account_not_subscribed - account_needs_reconnect - account_disconnected required: - id - channel - account_id - target_type - post_id - post_permalink - post_label - post_image_url - activated_at - resolved_at - expires_at - resolution_source required: - id - version - name - enabled - keywords - public_reply_enabled - public_replies - public_reply_selection - dm_message - dm_image - follow_gate_enabled - follow_gate_message - follow_gate_button_text - follow_gate_retry_message - follow_gate_retry_button_text - gates - buttons - flow - targets moved_from: description: >- Each post move_targets took off another automation, and which one. type: array items: type: object properties: automation_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ channel: type: string enum: - instagram - facebook account_id: type: string post_id: type: - string - 'null' required: - automation_id - channel - account_id - post_id required: - workspace - automation default: $ref: '#/components/responses/Error' components: responses: Error: description: Refused content: application/json: schema: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: >- Why the request was refused, such as AUTOMATION_NOT_FOUND or VERSION_CONFLICT. Other fields beside it give details. message: type: string description: The same reason, in English. securitySchemes: apiKey: type: http scheme: bearer description: A Replier API key (rpl_...). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.