Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Automations

List automations

List all automations for an account.

For feature availability, see Jobs (Strings).

get/accounts/{account_id}/automations

Path parameters

account_idstring required

Account ID

Query parameters

pageinteger

Page number

per_pageinteger

Limit on the number of objects to be returned, between 1 and 100. 25 by default

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
namestring
status'inactive' | 'active' | 'error'
trigger'schedule' | 'upload'
status_filtersstring[]

translation key statuses used to filter keys that are added to jobs

project_idstring
project_idsstring[]

All project IDs the automation applies to. Returned alongside the singular project_id for backwards compatibility.

job_template_idstring
job_owner_idstring nullable

User ID of the job owner that newly created jobs are assigned to.

include_only_updated_localesboolean

When true, the automation only acts on locales that changed since its last run.

tagsstring[]
cron_schedulestring
time_zonestring
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "My First Automation",
    "status": "active",
    "trigger": "schedule",
    "status_filters": [
      "unverified",
      "untranslated",
      "ready_for_review"
    ],
    "project_id": "abcd1234cdef1234abcd1234cdef1234",
    "job_template_id": "abcd1234cdef1234abcd1234cdef1234",
    "tags": [
      "tag-1",
      "tag-2"
    ],
    "cron_schedule": "00 13 * * 1,2",
    "time_zone": "GMT",
    "account": "account",
    "created_at": "2021-06-28T09:52:53Z",
    "updated_at": "2021-06-28T09:52:53Z"
  }
]