projectMembers

Reference

Project Members

Adds a new member to a project.

post/v1/projects/{idOrName}/members

Adds a new member to the project.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/projects/prj_pavWOn1iLObbXLRiwVvzmPrTWyTf/members?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "role": "ADMIN",
4    "email": "entity@example.com",
5    "uid": "ndlgr43fadlPyCtREAqxxdyFK",
6    "username": "example"
7  },
8  "headers": {
9    "Authorization": "Bearer <TOKEN>"
10  },
11  "method": "post"
12})

Parameters

Path Params

Query Params

Body Params

Path Parameter	Description
idOrName	string required The ID or name of the Project. Example:`prj_pavWOn1iLObbXLRiwVvzmPrTWyTf`

Response

Responds with the project ID on success.

idstringRequired

Response Codes

Code	Description
`200`	Responds with the project ID on success.
`400`	One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.
`500`

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/projects/prj_pavWOn1iLObbXLRiwVvzmPrTWyTf/members?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "body": {
3    "role": "ADMIN",
4    "email": "entity@example.com",
5    "uid": "ndlgr43fadlPyCtREAqxxdyFK",
6    "username": "example"
7  },
8  "headers": {
9    "Authorization": "Bearer <TOKEN>"
10  },
11  "method": "post"
12})

List project members

get/v1/projects/{idOrName}/members

Lists all members of a project.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/projects/prj_pavWOn1iLObbXLRiwVvzmPrTWyTf/members?limit=20&search=SOME_STRING_VALUE&since=1540095775951&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE&until=1540095775951", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
idOrName	string required The ID or name of the Project. Example:`prj_pavWOn1iLObbXLRiwVvzmPrTWyTf`

Response

One of the following objects
One of

Response Codes

Code	Description
`200`	Paginated list of members for the project.
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/projects/prj_pavWOn1iLObbXLRiwVvzmPrTWyTf/members?limit=20&search=SOME_STRING_VALUE&since=1540095775951&slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE&until=1540095775951", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "get"
6})

Remove a Project Member

delete/v1/projects/{idOrName}/members/{uid}

Remove a member from a specific project

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/projects/prj_pavWOn1iLObbXLRiwVvzmPrTWyTf/members/ndlgr43fadlPyCtREAqxxdyFK?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Parameters

Path Params

Query Params

Path Parameter	Description
idOrName	string required The ID or name of the Project. Example:`prj_pavWOn1iLObbXLRiwVvzmPrTWyTf`
uid	string required The user ID of the member. Example:`ndlgr43fadlPyCtREAqxxdyFK`

Response

idstringRequired

Response Codes

Code	Description
`200`
`400`	One of the provided values in the request query is invalid.
`401`
`403`	You do not have permission to access this resource.

Optional params

fetch-request

1await fetch("https://api.vercel.com/v1/projects/prj_pavWOn1iLObbXLRiwVvzmPrTWyTf/members/ndlgr43fadlPyCtREAqxxdyFK?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {
2  "headers": {
3    "Authorization": "Bearer <TOKEN>"
4  },
5  "method": "delete"
6})

Last updated on December 20, 2024

Update Resource Secrets

Adds a new member to a project.

Was this helpful?