---
title: "Get Action"
method: GET
path: "/actions/{actionId}"
tags: ["Actions"]
---

# Get Action

`GET /actions/{actionId}`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/actions/{actionId}`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

This endpoint can be used to retrieve a specific action by its ID.

## Response `200`

Action details.

- Action: Represents an action.
  - `id` string, uuid, required: The Action ID.
  - `name` string, required: The action's name.
  - `type` 'EMAIL' | 'SMS' | 'CALL' | 'TASK' | 'LETTER' | 'REGISTERED_LETTER', required: The action's type
  - `customer` CustomerLite, required: Minimal customer information.
    - `id` string, uuid, required: The Customer ID.
    - `externalId` string: An external ID that uniquely references the customer.
    - `companyName` string, required: Customer name.
    - `accountingRef` string: (Deprecated) Customer accounting reference (used in accounting tool). Use a custom field instead.
  - `createdAt` string, date-time, required: The date at which the action was created (ISO 8601 format).
  - `dueDate` string, date-time, required: The date when the action is due (ISO 8601 format).
  - `performedAt` string, date-time, nullable: The date when the action was performed (ISO 8601 format).
  - `state` 'TODO' | 'IGNORED' | 'EXECUTED' | 'IN_PROGRESS' | 'FAILED', required: State of the action.
  - `dunningPlan` DunningPlanLite: Minimal dunning plan information.
    - `id` string, uuid, required: The Dunning plan ID.
    - `name` string, required: The dunning plan name.
  - `performedBy` UserLite: Minimal user information.
    - `id` string, uuid, required: The User ID.
    - `firstName` string: The user's first name.
    - `lastName` string: The user's last name.
    - `email` string, email, required: The user's email address.
  - `assignedTo` UserLite[]: The users to whom the action is assigned.
    - `id` string, uuid, required: The User ID.
    - `firstName` string: The user's first name.
    - `lastName` string: The user's last name.
    - `email` string, email, required: The user's email address.
  - `recipients` object[]: List of recipients.
    - `type` 'EMAIL' | 'PHONE' | 'CONTACT' | 'MEMBER' | 'ALIAS', required: Recipient type.
    - `phone` string: Recipient phone number.
    - `email` string, email: Recipient email address.
  - `source` 'WORKFLOW' | 'CAMPAIGN' | 'BILLING': The source of the action.
  - `updatedAt` string, date-time: The date at which the action was last updated (ISO 8601 format).
  - `carryingInvoice` InvoiceReference: Reference to an invoice, identifiable by ID, external ID, or custom ID.
    - `id` string, uuid: Invoice ID.
    - `externalId` string: Invoice external ID.
    - `customId` string: Invoice custom ID.

---

[API](https://skmtc.dev/upflow/apis/upflow-api.md) - [All operations](https://skmtc.dev/upflow/apis/upflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upflow/apis/upflow-api/revisions/898a98ca0587?raw)