---
title: "Read Activity"
method: GET
path: "/companies/{company_id}/activity"
tags: ["activity"]
---

# Read Activity

`GET /companies/{company_id}/activity`

## Request

- Base URL: `https://app.zalster.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.zalster.com/companies/{company_id}/activity`
- Auth: none declared

Imports, exports, renders and image jobs of the company, newest first.

``running`` and ``paused`` count every run under way, not those on the page
(decision 210): the top bar asks for one item, and said "1 running" with
five going. One run at a time per subject (decision 207) keeps them few.
They count every kind whatever ``kind`` asks for (decision 221), which
narrows the list only.

## Path parameters

- `company_id` string, uuid, required: Company id

## Query parameters

- `only_active` boolean
- `limit` integer
- `kind` string, nullable: Only these kinds of run, a comma list of import, export, render and images; the newest `limit` of them. Every kind when left out.

## Response `200`

Successful Response

- ActivityPageOut: The company's runs, plus what is still waiting in the broker.
  - `items` ActivityOut[], required
    - `kind` string, required
    - `id` string, uuid, required
    - `status` string, required
    - `subject_id` string, uuid, required
    - `subject` string, nullable, required
    - `trigger` string, nullable, required
    - `done` integer, required
    - `total` integer, required
    - `failed` integer, required
    - `error_message` string, nullable, required
    - `job_id` string, nullable, required
    - `started_at` string, date-time, nullable, required
    - `finished_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, nullable, required
    - `is_running` boolean, required
    - `is_paused` boolean, required
    - `control` string, nullable, required
    - `progress` ActivityProgressOut, required: How far a run has got, in the terms of the step it is on.
      - `step` string, nullable, required
      - `done` integer, required
      - `total` integer, nullable, required
      - `unit` string, required
      - `rows` integer, nullable
      - `batch` integer, nullable
      - `batches` integer, nullable
    - `actions` ActivityActionsOut, required: What a person may ask of the run right now.
      - `pause` boolean, required
      - `resume` boolean, required
      - `cancel` boolean, required
      - `rerun` boolean, required
      - `notice` string, nullable
  - `running` integer, required
  - `paused` integer, required
  - `queues` object, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zalster/apis/zalster-feed-processor.md) - [All operations](https://skmtc.dev/zalster/apis/zalster-feed-processor/llms.txt) - [OpenAPI document](https://skmtc.dev/zalster/apis/zalster-feed-processor/revisions/d0b9dc66ad36?raw)