How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gitpod gitpod.v1.NotificationService API

NotificationService manages in-app notifications for users.

Gitpod gitpod.v1.NotificationService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.

Requests are made against a single base URL, https://api.gitpod.io.

4 operations 4 paths 18 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod gitpod.v1.NotificationService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.NotificationService 4

NotificationService manages in-app notifications for users.

POST
/gitpod.v1.NotificationService/DeleteNotifications
DeleteNotifications
gitpod.v1.NotificationService.DeleteNotifications body → 200default
POST
/gitpod.v1.NotificationService/ListNotifications
ListNotifications
gitpod.v1.NotificationService.ListNotifications 2 params body → 200default
POST
/gitpod.v1.NotificationService/MarkNotificationsRead
MarkNotificationsRead
gitpod.v1.NotificationService.MarkNotificationsRead body → 200default
POST
/gitpod.v1.NotificationService/MarkNotificationsUnread
MarkNotificationsUnread
gitpod.v1.NotificationService.MarkNotificationsUnread body → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.Notification (9 properties), gitpod.v1.ListNotificationsResponse (4 properties), gitpod.v1.NotificationContext (3 properties), gitpod.v1.NotificationContext.AgentExecutionContext (3 properties). Each schema is shown below with its type and property counts.

gitpod.v1.MarkNotificationsUnreadRequest
object
1 property
gitpod.v1.MarkNotificationsReadResponse
object
gitpod.v1.Notification
object
Notification represents an in-app notification for a user.
9 properties 1 required
gitpod.v1.ListNotificationsResponse
object
4 properties
gitpod.v1.DeleteNotificationsResponse
object
gitpod.v1.ListNotificationsRequest
object
3 properties
gitpod.v1.MarkNotificationsReadRequest
object
1 property
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.MarkNotificationsUnreadResponse
object
gitpod.v1.NotificationType
string
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.NotificationContext.EnvironmentContext
object
1 property
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.DeleteNotificationsRequest
object
1 property
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.NotificationContext
object
NotificationContext carries structured metadata for click-through navigation. Context is snapshotted at emit time so deleted resources still have display names.
3 properties
gitpod.v1.NotificationContext.ProjectContext
object
2 properties
gitpod.v1.NotificationContext.AgentExecutionContext
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-notificationservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Where this information came from

This is an independent, third-party profile of Gitpod gitpod.v1.NotificationService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.