Get a repository subscription

GET

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

Gets information about whether the authenticated user is subscribed to the repository.

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

Responses

200

If you subscribe to the repository

Media type application/json

Repository Invitation

Repository invitations let you manage who you collaborate with.

object

subscribed

required

Determines if notifications should be received from this repository.

boolean

ignored

required

Determines if all notifications should be blocked from this repository.

boolean

reason

required

string

nullable

created_at

required

string format: date-time

url

required

string format: uri

repository_url

required

string format: uri

Examples

Example response-if-you-subscribe-to-the-repository

{
  "subscribed": true,
  "ignored": false,
  "reason": null,
  "created_at": "2012-10-06T21:34:12Z",
  "url": "https://api.github.com/repos/octocat/example/subscription",
  "repository_url": "https://api.github.com/repos/octocat/example"
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Not Found if you don’t subscribe to the repository