---
title: "Query Events"
method: GET
path: "/events"
tags: ["Event"]
---

# Query Events

`GET /events`

Used to query events

## Query parameters

- `workspace_id` string
- `environment_id` string
- `application_id` string
- `limit` integer
- `cursor` string

## Response `200`

Results of the query

- EventQueryResult
  - `events` Event[] — All events that matched the query
    - `id` string — Unique ID for this event
    - `workspace_id` string, required — The ID of the workspace associated with this event
    - `environment_id` string — The ID of the environment associated with this event
    - `application_id` string — The ID of the application associated with this event
    - `event_type` string — The type of event
    - `event_time` integer — Time at which the event occurred
    - `source_control` SourceControl
      - `revision` string — the primary source revision associated with this object
      - `revisions` string[] — all source revision ids associated with this object
      - `commit_username` string — the username of the user who committed the revision associated with this object
      - `branch_name` string — the branch associated with this object
      - `branches` SourceControlBranch[] — Related branches
        - `name` string, required — repository unique branch name
        - `html_url` string, required — HTML page url to view branch tree
      - `pull_request` SourceControlPullRequest — the pull request associated with this object
        - `id` string — vendor unique pull request identifier (immutable)
        - `number` integer — the number associated with the pull request (repository unique)
        - `title` string — the title of the pull request
        - `html_url` string — HTML page url to view pull request object
      - `pull_requests` SourceControlPullRequest[] — Related pull requests
        - `id` string — vendor unique pull request identifier (immutable)
        - `number` integer — the number associated with the pull request (repository unique)
        - `title` string — the title of the pull request
        - `html_url` string — HTML page url to view pull request object
      - `authors` SourceControlAuthor[] — Related authors. Should be at least one
        - `id` string, required — vendor unique author id (invariant)
        - `user_name` string, required — author username name (mutable)
        - `name` string — author full name (mutable)
        - `email` string — author email
        - `html_url` string, required — HTML page url to view author
        - `avatar_url` string, required — author avatar image URL
        - `user_type` string — repository name unique within owner scope
      - `repository_url` string — the url of the repository associated with this object
      - `repository_name` string — the name of the repository associated with this object
      - `repository` SourceControlRepository — the SCM repository associated with this object
        - `id` string, required — vendor unique repository id (immutable)
        - `name` string, required — repository name unique within owner scope
        - `full_name` string — vendor unique name to identify this repo across all vendor's repos
        - `owner_name` string, required — repository name unique within owner scope
        - `owner` SourceControlRepositoryOwner — the SCM repository associated with this object
          - `id` string, required — vendor unique repository id (immutable)
          - `name` string, required — repository name unique within owner scope
          - `owner_type` string, required — repository name unique within owner scope
          - `html_url` string, required — HTML page url to view branch tree
          - `avatar_url` string — owner avatar image URL
        - `html_url` string, required — HTML page url to view branch tree
        - `is_public` boolean — true if repository publicly visible
        - `checkout_url` string — SCM remote checkout path
    - `received_time` integer — Time at which the event was received by the API
    - `revision` string — Revision associated with the event
    - `properties` object — Arbitrary key-value pairs used to pass additional information about this event
    - `type_specific_fields` object — Additional key-value pairs used to record additional, canonical fields relevant to only some event types
    - `triggered_plan_run_summaries` DeploymentPlanSummary[] — Summaries of the plans that ran as a result of this event
      - `plan_id` string — Unique ID for this plan
      - `plan_run_id` string — The ID of run of the plan
  - `cursor` string — Cursor used for pagination

## Other responses

- `400` — Invalid or missing parameter
- `401` — User not authenticated
- `403` — User not authorized
- `default` — Unknown error

---

[API](https://skmtc.net/mabl/apis/mabl-api.md) · [All operations](https://skmtc.net/mabl/apis/mabl-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mabl/mabl-api/revisions/d0fc0114da66/schema)