Get a thread subscription for the authenticated user

GET /notifications/threads/{thread_id}/subscription

Copy endpoint

https://api.github.com

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

Parameters

path Path Parameters

Name	Type
`thread_id` required The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the `GET /notifications` operation).	number

Responses

200 application/json

Response

interface ThreadSubscription {
subscribed: boolean;
ignored: boolean;
reason: string | null;
created_at: string | null;
url: string;
thread_url?: string;
repository_url?: string;
}

Redirects

304

Not modified

unknown

Client Errors

401 application/json

Requires authentication

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

403 application/json

Forbidden

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}