APIs.io Engineering Platform Activity API

Activity APIs provide access to notifications, subscriptions, and timelines.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 31 operations across 22 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

31 operations 22 paths 24 schemas 3 DELETE22 GET1 PATCH5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Activity API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 31

Across 22 paths, the API surfaces 31 operations — 3 DELETE, 22 GET, 1 PATCH, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Activity 31

Activity APIs provide access to notifications, subscriptions, and timelines.

GET

/events

APIs.io Engineering Platform List public events

activity/list-public-events 2 params → 200304403503

GET

/feeds

APIs.io Engineering Platform Get feeds

activity/get-feeds → 200

GET

/networks/{owner}/{repo}/events

APIs.io Engineering Platform List public events for a network of repositories

activity/list-public-events-for-repo-network 4 params → 200404403304301

GET

/notifications

APIs.io Engineering Platform List notifications for the authenticated user

activity/list-notifications-for-authenticated-user 6 params → 200304403401422

PUT

/notifications

APIs.io Engineering Platform Mark notifications as read

activity/mark-notifications-as-read body → 202205304403401

GET

/notifications/threads/{thread_id}

APIs.io Engineering Platform Get a thread

activity/get-thread 1 param → 200304403401

PATCH

/notifications/threads/{thread_id}

APIs.io Engineering Platform Mark a thread as read

activity/mark-thread-as-read 1 param → 205304403

GET

/notifications/threads/{thread_id}/subscription

APIs.io Engineering Platform Get a thread subscription for the authenticated user

activity/get-thread-subscription-for-authenticated-user 1 param → 200304403401

PUT

/notifications/threads/{thread_id}/subscription

APIs.io Engineering Platform Set a thread subscription

activity/set-thread-subscription 1 param body → 200304403401

DELETE

/notifications/threads/{thread_id}/subscription

APIs.io Engineering Platform Delete a thread subscription

activity/delete-thread-subscription 1 param → 204304403401

GET

/orgs/{org}/events

APIs.io Engineering Platform List public organization events

activity/list-public-org-events 3 params → 200

GET

/repos/{owner}/{repo}/events

APIs.io Engineering Platform List repository events

activity/list-repo-events 4 params → 200

GET

/repos/{owner}/{repo}/notifications

APIs.io Engineering Platform List repository notifications for the authenticated user

activity/list-repo-notifications-for-authenticated-user 8 params → 200

PUT

/repos/{owner}/{repo}/notifications

APIs.io Engineering Platform Mark repository notifications as read

activity/mark-repo-notifications-as-read 2 params body → 202205

GET

/repos/{owner}/{repo}/stargazers

APIs.io Engineering Platform List stargazers

activity/list-stargazers-for-repo 4 params → 200422

GET

/repos/{owner}/{repo}/subscribers

APIs.io Engineering Platform List watchers

activity/list-watchers-for-repo 4 params → 200

GET

/repos/{owner}/{repo}/subscription

APIs.io Engineering Platform Get a repository subscription

activity/get-repo-subscription 2 params → 200404403

PUT

/repos/{owner}/{repo}/subscription

APIs.io Engineering Platform Set a repository subscription

activity/set-repo-subscription 2 params body → 200

DELETE

/repos/{owner}/{repo}/subscription

APIs.io Engineering Platform Delete a repository subscription

activity/delete-repo-subscription 2 params → 204

GET

/user/starred

APIs.io Engineering Platform List repositories starred by the authenticated user

activity/list-repos-starred-by-authenticated-user 4 params → 200304403401

GET

/user/starred/{owner}/{repo}

APIs.io Engineering Platform Check if a repository is starred by the authenticated user

activity/check-repo-is-starred-by-authenticated-user 2 params → 204404401304403

PUT

/user/starred/{owner}/{repo}

APIs.io Engineering Platform Star a repository for the authenticated user

activity/star-repo-for-authenticated-user 2 params → 204403404401304

DELETE

/user/starred/{owner}/{repo}

APIs.io Engineering Platform Unstar a repository for the authenticated user

activity/unstar-repo-for-authenticated-user 2 params → 204404401304403

GET

/user/subscriptions

APIs.io Engineering Platform List repositories watched by the authenticated user

activity/list-watched-repos-for-authenticated-user 2 params → 200304403401

GET

/users/{username}/events

APIs.io Engineering Platform List events for the authenticated user

activity/list-events-for-authenticated-user 3 params → 200

GET

/users/{username}/events/orgs/{org}

APIs.io Engineering Platform List organization events for the authenticated user

activity/list-org-events-for-authenticated-user 4 params → 200

GET

/users/{username}/events/public

APIs.io Engineering Platform List public events for a user

activity/list-public-events-for-user 3 params → 200

GET

/users/{username}/received_events

APIs.io Engineering Platform List events received by the authenticated user

activity/list-received-events-for-user 3 params → 200

GET

/users/{username}/received_events/public

APIs.io Engineering Platform List public events received by a user

activity/list-received-public-events-for-user 3 params → 200

GET

/users/{username}/starred

APIs.io Engineering Platform List repositories starred by a user

activity/list-repos-starred-by-user 5 params → 200

GET

/users/{username}/subscriptions

APIs.io Engineering Platform List repositories watched by a user

activity/list-repos-watched-by-user 3 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), minimal-repository (87 properties), issue (34 properties), simple-user (21 properties). Each schema is shown below with its type and property counts.

nullable-simple-user

object

A GitHub user.

21 properties 18 required

nullable-integration

object

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…

17 properties 11 required

repository

object

A repository on GitHub.

95 properties 73 required

link-with-type

object

Hypermedia Link with Type

2 properties 2 required

code-of-conduct

object

Code Of Conduct

5 properties 4 required

event

object

Event

8 properties 7 required

feed

object

Feed

11 properties 3 required

stargazer

object

Stargazer

2 properties 2 required

issue-comment

object

Comments provide a way for people to collaborate on an issue.

14 properties 9 required

basic-error

object

Basic Error

4 properties

nullable-milestone

object

A collection of related issues and pull requests.

16 properties 16 required

thread

object

Thread

9 properties 9 required

thread-subscription

object

Thread Subscription

7 properties 5 required

reaction-rollup

object

10 properties 10 required

actor

object

Actor

6 properties 5 required

validation-error

object

Validation Error

3 properties 2 required

simple-user

object

A GitHub user.

21 properties 18 required

issue

object

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

34 properties 21 required

minimal-repository

object

Minimal Repository

87 properties 46 required

starred-repository

object

Starred Repository

2 properties 2 required

nullable-license-simple

object

License Simple

6 properties 5 required

author-association

string

How the author is associated with the repository.

security-and-analysis

object

3 properties

repository-subscription

object

Repository invitations let you manage who you collaborate with.

6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Activity

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Activity API

Metadata

Authentication & Security 1

Paths & Operations 31

Schemas 24

Specification

Source

API Details

Provider

Explore more