Colaboradores de Project board

La API de colaboradores de project board permite administrar los colaboradores de una instancia de project board.

List project collaborators

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

Parámetros

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`project_id`integerRequired The unique identifier of the project.
Query parameters
Name, Type, Description
`affiliation`string Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. Default: `all` Can be one of: `outside`, `direct`, `all`
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

Códigos de estado de respuesta HTTP

status code	Descripción
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código

get/projects/{project_id}/collaborators

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators

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
  }
]

Aviso de previsualización

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Add project collaborator

Funciona con GitHub Apps

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

Parámetros

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`project_id`integerRequired The unique identifier of the project.
`username`stringRequired The handle for the GitHub user account.
Body parameters
Name, Type, Description
`permission`string The permission to grant the collaborator. Default: `write` Can be one of: `read`, `write`, `admin`

Códigos de estado de respuesta HTTP

status code	Descripción
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código

put/projects/{project_id}/collaborators/{username}

curl \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators/USERNAME \
  -d '{"permission":"write"}'

Response

Status: 204

Aviso de previsualización

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Remove user as a collaborator

Funciona con GitHub Apps

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

Parámetros

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`project_id`integerRequired The unique identifier of the project.
`username`stringRequired The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

status code	Descripción
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código

delete/projects/{project_id}/collaborators/{username}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators/USERNAME

Response

Status: 204

Aviso de previsualización

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json

Get project permission for a user

Funciona con GitHub Apps

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

Parámetros

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended. See preview notice
Path parameters
Name, Type, Description
`project_id`integerRequired The unique identifier of the project.
`username`stringRequired The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

status code	Descripción
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Ejemplos de código

get/projects/{project_id}/collaborators/{username}/permission

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators/USERNAME/permission

Response

Status: 200

{
  "permission": "admin",
  "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
  }
}

Aviso de previsualización

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.inertia-preview+json