The deepgram.members object provides access to the members endpoints of the Deepgram API. Each request is project based and will require a project_id.

List Project Members

You can retrieve all members on a given project using the members.listMembers function.

List Project Members Parameters

ParameterTypeDescription
project_idStringA unique identifier for the project you wish to see the members of

List Project Members Example Request

const response = await deepgram.members.listMembers(PROJECT_ID);

List Project Members Response

{
  members: [
    {
      member_id: string,
      scopes: Array<string>
      email: string,
      first_name: string,
      last_name: string,
    },
  ];
}

Remove Project Member

You can remove a member from a given project using the members.removeMember function.

Remove Project Member Parameters

ParameterTypeDescription
project_idStringA unique identifier for the project you wish to see the members of
member_idStringA unique identifier for the member you wish to remove

Remove Project Members Example Request

const response = await deepgram.members.removeMember(PROJECT_ID, MEMBER_ID);

Remove Project Members Response

{
	message: string;
}