UPupflow
Actions

List Actions

List actions with optional filtering.

get/actions

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger
Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger
Example:100

Maximum number of items to return per page.

sortBy'createdAt' | 'updatedAt' | 'dueDate' | 'performedAt'

Sort actions by a specific column.

sortOrder'DESC' | 'ASC'

Sort order.

updatedAt.gtstring date-time

Minimum value to filter by (exclusive)

updatedAt.gtestring date-time

Minimum value to filter by (inclusive)

updatedAt.ltstring date-time

Maximum value to filter by (exclusive)

updatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "updatedAt.gt": "2015-05-05T12:30:00Z",
  "updatedAt.gte": "2015-05-05T12:30:00Z",
  "updatedAt.lt": "2015-05-05T12:30:00Z",
  "updatedAt.lte": "2015-05-05T12:30:00Z"
}
dueDate.gtstring date-time

Minimum value to filter by (exclusive)

dueDate.gtestring date-time

Minimum value to filter by (inclusive)

dueDate.ltstring date-time

Maximum value to filter by (exclusive)

dueDate.ltestring date-time

Maximum value to filter by (inclusive)

{
  "dueDate.gt": "2015-05-05T12:30:00Z",
  "dueDate.gte": "2015-05-05T12:30:00Z",
  "dueDate.lt": "2015-05-05T12:30:00Z",
  "dueDate.lte": "2015-05-05T12:30:00Z"
}
performedAt.gtstring date-time

Minimum value to filter by (exclusive)

performedAt.gtestring date-time

Minimum value to filter by (inclusive)

performedAt.ltstring date-time

Maximum value to filter by (exclusive)

performedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "performedAt.gt": "2015-05-05T12:30:00Z",
  "performedAt.gte": "2015-05-05T12:30:00Z",
  "performedAt.lt": "2015-05-05T12:30:00Z",
  "performedAt.lte": "2015-05-05T12:30:00Z"
}
state'TODO' | 'IGNORED' | 'EXECUTED' | 'IN_PROGRESS' | 'FAILED'

State of the action.

Filter actions by state.

source'WORKFLOW' | 'CAMPAIGN' | 'BILLING'

The source of the action.

Filter actions by source.

customerIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter actions by Customer ID.

carryingInvoiceIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter actions by carrying invoice ID.

assignedToUserIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter actions by assigned user ID.

performedByUserIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter actions by the user who performed the action.

Response

Paginated list of actions.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "items": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "name": "1st reminder: payment not received",
      "type": "EMAIL",
      "customer": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "1a2c3b",
        "companyName": "Upflow SAS",
        "accountingRef": "UPFL-SAS"
      },
      "createdAt": "2015-05-05T12:30:00Z",
      "dueDate": "2015-05-05T12:30:00Z",
      "performedAt": "2015-05-05T12:30:00Z",
      "dunningPlan": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "name": "Standard dunning plan"
      },
      "performedBy": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "firstName": "John",
        "lastName": "Doe",
        "email": "user@email.com"
      },
      "assignedTo": [
        {
          "id": "00a70b35-2be3-4c43-aefb-397190134655",
          "firstName": "John",
          "lastName": "Doe",
          "email": "user@email.com"
        }
      ],
      "recipients": [
        {
          "type": "EMAIL",
          "email": "recipient@company.com"
        },
        {
          "type": "CONTACT",
          "email": "contact@email.com",
          "phone": "+12673148110"
        }
      ],
      "updatedAt": "2015-05-05T12:30:00Z",
      "carryingInvoice": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "92842AB37",
        "customId": "FAC123"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.