projectMembers

List project members

Changed on

Lists all members of a project.

get/v1/projects/{idOrName}/members

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/projects/{idOrName}/members
  • Auth: HTTP bearer

Path parameters

idOrNamestring required

The ID or name of the Project.

Example:prj_pavWOn1iLObbXLRiwVvzmPrTWyTf

Query parameters

limitinteger

Limit how many project members should be returned

Example:20
sinceinteger

Timestamp in milliseconds to only include members added since then.

Example:1540095775951
untilinteger

Timestamp in milliseconds to only include members added until then.

Example:1540095775951
searchstring

Search project members by their name, username, and email.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Paginated list of members for the project.

object required
OR

Example response

{
  "members": [
    {
      "avatar": "123a6c5209bc3778245d011443644c8d27dc2c50",
      "computedProjectRole": "ADMIN",
      "createdAt": 1588720733602,
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "role": "ADMIN",
      "teamRole": "CONTRIBUTOR",
      "uid": "zTuNVUXEAvvnNN3IaqinkyMw",
      "username": "jane-doe"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Changes