Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Query Parameters

q
string

Full-text search across the event's name, provider and description, case-insensitive. Each word matches the start of a word, and every word must match.

Example:

"job"

provider
enum<string>

Restrict results to events from a single product: strings (Phrase Strings), tms (Phrase TMS, the translation management system) or orchestrator (Orchestrator, including schedules and webhooks).

Available options:
strings,
tms,
orchestrator
Example:

"tms"

page
integer
default:1

Page number to return, starting at 1.

Required range: x >= 1
Example:

1

page_size
integer
default:25

Number of results per page. Default 25, maximum 100.

Required range: 1 <= x <= 100
Example:

25

Response

OK

Events the authenticated user can use as a workflow trigger.

events
Event · object[]
required

Available events.

meta
PaginationMeta · object
required

Page-based pagination metadata for a list response.

Example: