The REST API is now versioned.For more information, see "About API versioning."

REST API endpoints for issue assignees

Use the REST API to manage assignees on issues and pull requests.

About issue and pull request assignees

You can use the REST API to view, add, and remove assignees on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like managing assignees, labels, and milestones, are provided within the Issues endpoints.

List assignees

Lists theavailable assignees for issues in a repository.

Fine-grained access tokens for "List assignees"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Issues" repository permissions (read)
"Pull requests" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List assignees"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.

Query parameters
Name, Type, Description
`per_page`integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default:`30`
`page`integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default:`1`

HTTP response status codes for "List assignees"

Status code	Description
`200`	OK
`404`	Resource not found

Code samples for "List assignees"

Request example

get/repos/{owner}/{repo}/assignees

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/assignees

Response

Status: 200

[  {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  }]

Check if a user can be assigned

Checks if a user has permission to be assigned to an issue in this repository.

If theassignee can be assigned to issues in the repository, a204 header with no content is returned.

Otherwise a404 status code is returned.

Fine-grained access tokens for "Check if a user can be assigned"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Issues" repository permissions (read)
"Pull requests" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Check if a user can be assigned"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`assignee`stringRequired

HTTP response status codes for "Check if a user can be assigned"

Status code	Description
`204`	If the`assignee` can be assigned to issues in the repository, a`204` header with no content is returned.
`404`	Otherwise a`404` status code is returned.

Code samples for "Check if a user can be assigned"

Request example

get/repos/{owner}/{repo}/assignees/{assignee}

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/assignees/ASSIGNEE

If the`assignee` can be assigned to issues in the repository, a`204` header with no content is returned.

Status: 204

Add assignees to an issue

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

Fine-grained access tokens for "Add assignees to an issue"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Issues" repository permissions (write)
"Pull requests" repository permissions (write)

Parameters for "Add assignees to an issue"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.

Body parameters
Name, Type, Description
`assignees`array of strings Usernames of people to assign this issue to.NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

HTTP response status codes for "Add assignees to an issue"

Status code	Description
`201`	Created

Code samples for "Add assignees to an issue"

Request example

post/repos/{owner}/{repo}/issues/{issue_number}/assignees

curl -L \  -X POST \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/assignees \  -d '{"assignees":["hubot","other_user"]}'

Response

Status: 201

{  "id": 1,  "node_id": "MDU6SXNzdWUx",  "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",  "repository_url": "https://api.github.com/repos/octocat/Hello-World",  "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",  "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",  "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",  "html_url": "https://github.com/octocat/Hello-World/issues/1347",  "number": 1347,  "state": "open",  "title": "Found a bug",  "body": "I'm having a problem with this.",  "user": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "labels": [    {      "id": 208045946,      "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",      "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",      "name": "bug",      "description": "Something isn't working",      "color": "f29513",      "default": true    }  ],  "assignee": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assignees": [    {      "login": "octocat",      "id": 1,      "node_id": "MDQ6VXNlcjE=",      "avatar_url": "https://github.com/images/error/octocat_happy.gif",      "gravatar_id": "",      "url": "https://api.github.com/users/octocat",      "html_url": "https://github.com/octocat",      "followers_url": "https://api.github.com/users/octocat/followers",      "following_url": "https://api.github.com/users/octocat/following{/other_user}",      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",      "organizations_url": "https://api.github.com/users/octocat/orgs",      "repos_url": "https://api.github.com/users/octocat/repos",      "events_url": "https://api.github.com/users/octocat/events{/privacy}",      "received_events_url": "https://api.github.com/users/octocat/received_events",      "type": "User",      "site_admin": false    }  ],  "milestone": {    "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",    "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",    "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",    "id": 1002604,    "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",    "number": 1,    "state": "open",    "title": "v1.0",    "description": "Tracking milestone for version 1.0",    "creator": {      "login": "octocat",      "id": 1,      "node_id": "MDQ6VXNlcjE=",      "avatar_url": "https://github.com/images/error/octocat_happy.gif",      "gravatar_id": "",      "url": "https://api.github.com/users/octocat",      "html_url": "https://github.com/octocat",      "followers_url": "https://api.github.com/users/octocat/followers",      "following_url": "https://api.github.com/users/octocat/following{/other_user}",      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",      "organizations_url": "https://api.github.com/users/octocat/orgs",      "repos_url": "https://api.github.com/users/octocat/repos",      "events_url": "https://api.github.com/users/octocat/events{/privacy}",      "received_events_url": "https://api.github.com/users/octocat/received_events",      "type": "User",      "site_admin": false    },    "open_issues": 4,    "closed_issues": 8,    "created_at": "2011-04-10T20:09:31Z",    "updated_at": "2014-03-03T18:58:10Z",    "closed_at": "2013-02-12T13:22:01Z",    "due_on": "2012-10-09T23:39:01Z"  },  "locked": true,  "active_lock_reason": "too heated",  "comments": 0,  "pull_request": {    "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",    "html_url": "https://github.com/octocat/Hello-World/pull/1347",    "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",    "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"  },  "closed_at": null,  "created_at": "2011-04-22T13:33:48Z",  "updated_at": "2011-04-22T13:33:48Z",  "closed_by": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "author_association": "COLLABORATOR",  "state_reason": "completed"}

Remove assignees from an issue

Removes one or more assignees from an issue.

Fine-grained access tokens for "Remove assignees from an issue"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Issues" repository permissions (write)
"Pull requests" repository permissions (write)

Parameters for "Remove assignees from an issue"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.

Body parameters
Name, Type, Description
`assignees`array of strings Usernames of assignees to remove from an issue.NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

HTTP response status codes for "Remove assignees from an issue"

Status code	Description
`200`	OK

Code samples for "Remove assignees from an issue"

Request example

delete/repos/{owner}/{repo}/issues/{issue_number}/assignees

curl -L \  -X DELETE \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/assignees \  -d '{"assignees":["hubot","other_user"]}'

Response

Status: 200

{  "id": 1,  "node_id": "MDU6SXNzdWUx",  "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",  "repository_url": "https://api.github.com/repos/octocat/Hello-World",  "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}",  "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments",  "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events",  "html_url": "https://github.com/octocat/Hello-World/issues/1347",  "number": 1347,  "state": "open",  "title": "Found a bug",  "body": "I'm having a problem with this.",  "user": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "labels": [    {      "id": 208045946,      "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",      "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",      "name": "bug",      "description": "Something isn't working",      "color": "f29513",      "default": true    }  ],  "assignee": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "assignees": [    {      "login": "octocat",      "id": 1,      "node_id": "MDQ6VXNlcjE=",      "avatar_url": "https://github.com/images/error/octocat_happy.gif",      "gravatar_id": "",      "url": "https://api.github.com/users/octocat",      "html_url": "https://github.com/octocat",      "followers_url": "https://api.github.com/users/octocat/followers",      "following_url": "https://api.github.com/users/octocat/following{/other_user}",      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",      "organizations_url": "https://api.github.com/users/octocat/orgs",      "repos_url": "https://api.github.com/users/octocat/repos",      "events_url": "https://api.github.com/users/octocat/events{/privacy}",      "received_events_url": "https://api.github.com/users/octocat/received_events",      "type": "User",      "site_admin": false    }  ],  "milestone": {    "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",    "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",    "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",    "id": 1002604,    "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",    "number": 1,    "state": "open",    "title": "v1.0",    "description": "Tracking milestone for version 1.0",    "creator": {      "login": "octocat",      "id": 1,      "node_id": "MDQ6VXNlcjE=",      "avatar_url": "https://github.com/images/error/octocat_happy.gif",      "gravatar_id": "",      "url": "https://api.github.com/users/octocat",      "html_url": "https://github.com/octocat",      "followers_url": "https://api.github.com/users/octocat/followers",      "following_url": "https://api.github.com/users/octocat/following{/other_user}",      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",      "organizations_url": "https://api.github.com/users/octocat/orgs",      "repos_url": "https://api.github.com/users/octocat/repos",      "events_url": "https://api.github.com/users/octocat/events{/privacy}",      "received_events_url": "https://api.github.com/users/octocat/received_events",      "type": "User",      "site_admin": false    },    "open_issues": 4,    "closed_issues": 8,    "created_at": "2011-04-10T20:09:31Z",    "updated_at": "2014-03-03T18:58:10Z",    "closed_at": "2013-02-12T13:22:01Z",    "due_on": "2012-10-09T23:39:01Z"  },  "locked": true,  "active_lock_reason": "too heated",  "comments": 0,  "pull_request": {    "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347",    "html_url": "https://github.com/octocat/Hello-World/pull/1347",    "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",    "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"  },  "closed_at": null,  "created_at": "2011-04-22T13:33:48Z",  "updated_at": "2011-04-22T13:33:48Z",  "closed_by": {    "login": "octocat",    "id": 1,    "node_id": "MDQ6VXNlcjE=",    "avatar_url": "https://github.com/images/error/octocat_happy.gif",    "gravatar_id": "",    "url": "https://api.github.com/users/octocat",    "html_url": "https://github.com/octocat",    "followers_url": "https://api.github.com/users/octocat/followers",    "following_url": "https://api.github.com/users/octocat/following{/other_user}",    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",    "organizations_url": "https://api.github.com/users/octocat/orgs",    "repos_url": "https://api.github.com/users/octocat/repos",    "events_url": "https://api.github.com/users/octocat/events{/privacy}",    "received_events_url": "https://api.github.com/users/octocat/received_events",    "type": "User",    "site_admin": false  },  "author_association": "COLLABORATOR",  "state_reason": "completed"}

Check if a user can be assigned to a issue

Checks if a user has permission to be assigned to a specific issue.

If theassignee can be assigned to this issue, a204 status code with no content is returned.

Otherwise a404 status code is returned.

Fine-grained access tokens for "Check if a user can be assigned to a issue"

This endpoint works with the following fine-grained token types:

The fine-grained token must have at least one of the following permission sets:

"Issues" repository permissions (read)
"Pull requests" repository permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Check if a user can be assigned to a issue"

Headers
Name, Type, Description
`accept`string Setting to`application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository without the`.git` extension. The name is not case sensitive.
`issue_number`integerRequired The number that identifies the issue.
`assignee`stringRequired

HTTP response status codes for "Check if a user can be assigned to a issue"

Status code	Description
`204`	Response if`assignee` can be assigned to`issue_number`
`404`	Response if`assignee` can not be assigned to`issue_number`

Code samples for "Check if a user can be assigned to a issue"

Request example

get/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}

curl -L \  -H "Accept: application/vnd.github+json" \  -H "Authorization: Bearer <YOUR-TOKEN>" \  -H "X-GitHub-Api-Version: 2022-11-28" \  https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/assignees/ASSIGNEE

Response if`assignee` can be assigned to`issue_number`

Status: 204

Movatterモバイル変換

REST API endpoints for issue assignees

Request example

Response

Request example

If theassignee can be assigned to issues in the repository, a204 header with no content is returned.

Request example

Response

Request example

Response

Request example

Response ifassignee can be assigned toissue_number

If the`assignee` can be assigned to issues in the repository, a`204` header with no content is returned.

Response if`assignee` can be assigned to`issue_number`