request

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

Overview

Name	request
Type	Resource
Id	vercel.teams.request

Fields

The following fields are returned by SELECT queries:

get_team_access_request

Successfully

Name	Datatype	Description
accessRequestedAt	number	Timestamp in milliseconds when the user requested access to the team.
bitbucket	object	Map of the connected Bitbucket account.
confirmed	boolean	Current status of the membership. Will be true if confirmed, if pending it'll be false.
github	object	Map of the connected GitHub account.
gitlab	object	Map of the connected GitLab account.
joinedFrom	object	A map that describes the origin from where the user joined.
teamName	string	The name of the team. (example: My Team)
teamSlug	string	The slug of the team. (example: my-team)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_team_access_request	select	teamId, userId		Check the status of a join request. It'll respond with a 404 if the request has been declined. If no userId path segment was provided, this endpoint will instead return the status of the authenticated user.
request_access_to_team	exec	teamId, joinedFrom		Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time.

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
teamId	string	ID of the Team.
userId	string	User ID.

SELECT examples

get_team_access_request

Check the status of a join request. It'll respond with a 404 if the request has been declined. If no userId path segment was provided, this endpoint will instead return the status of the authenticated user.

SELECT
accessRequestedAt,
bitbucket,
confirmed,
github,
gitlab,
joinedFrom,
teamName,
teamSlug
FROM vercel.teams.request
WHERE teamId = '{{ teamId }}' -- required
AND userId = '{{ userId }}' -- required
;

Lifecycle Methods

request_access_to_team

Request access to a team as a member. An owner has to approve the request. Only 10 users can request access to a team at the same time.

EXEC vercel.teams.request.request_access_to_team 
@teamId='{{ teamId }}' --required 
@@json=
'{
"joinedFrom": "{{ joinedFrom }}"
}'
;