projects_members

Creates, updates, deletes, gets or lists a projects_members resource.

Overview

Name	projects_members
Type	Resource
Id	vercel.project_members.projects_members

Fields

The following fields are returned by SELECT queries:

get_project_members

Paginated list of members for the project.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_project_members	select	idOrName, teamId	limit, since, until, search	Lists all members of a project.
remove_project_member	delete	idOrName, uid, teamId		Remove a member from a specific project
_get_project_members	exec	idOrName, teamId	limit, since, until, search	Lists all members of a project.
add_project_member	exec	idOrName, teamId, uid		Adds a new member to the project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
idOrName	string	The ID or name of the Project.
teamId	string	The Team identifier or slug to perform the request on behalf of.
uid	string	The user ID of the member.
limit	integer	Limit how many project members should be returned
search	string	Search project members by their name, username, and email.
since	integer	Timestamp in milliseconds to only include members added since then.
until	integer	Timestamp in milliseconds to only include members added until then.

SELECT examples

get_project_members

Lists all members of a project.

SELECT
*
FROM vercel.project_members.projects_members
WHERE idOrName = '{{ idOrName }}' -- required
AND teamId = '{{ teamId }}' -- required
AND limit = '{{ limit }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND search = '{{ search }}'
;

DELETE examples

remove_project_member

Remove a member from a specific project

DELETE FROM vercel.project_members.projects_members
WHERE idOrName = '{{ idOrName }}' --required
AND uid = '{{ uid }}' --required
AND teamId = '{{ teamId }}' --required
;

Lifecycle Methods

_get_project_members

Lists all members of a project.

EXEC vercel.project_members.projects_members._get_project_members 
@idOrName='{{ idOrName }}' --required, 
@teamId='{{ teamId }}' --required, 
@limit='{{ limit }}', 
@since='{{ since }}', 
@until='{{ until }}', 
@search='{{ search }}'
;

add_project_member

Adds a new member to the project.

EXEC vercel.project_members.projects_members.add_project_member 
@idOrName='{{ idOrName }}' --required, 
@teamId='{{ teamId }}' --required 
@@json=
'{
"uid": "{{ uid }}", 
"username": "{{ username }}", 
"email": "{{ email }}", 
"role": "{{ role }}"
}'
;