group_contacts

Gets or lists a group_contacts resource.

Overview

Name	group_contacts
Type	Resource
Id	gitlab.groups.group_contacts

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	Internal ID of the contact.
first_name	string	First name of the contact.
last_name	string	Last name of the contact.
active	boolean	State of the contact.
created_at	string	Timestamp the contact was created.
description	string	Description of or notes for the contact.
email	string	Email address of the contact.
phone	string	Phone number of the contact.
updated_at	string	Timestamp the contact was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	search, sort, state	Find contacts of this group. Generated from the GitLab GraphQL schema field Group.contacts (connection of CustomerRelationsContact nodes).

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
full_path	string	Full path of the group, for example gitlab-org
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
search	string	Search term to find contacts with.
sort	string	Criteria to sort contacts by.
state	string	State of the contacts to search for.

SELECT examples

list

Find contacts of this group. Generated from the GitLab GraphQL schema field Group.contacts (connection of CustomerRelationsContact nodes).

SELECT
id,
first_name,
last_name,
active,
created_at,
description,
email,
phone,
updated_at
FROM gitlab.groups.group_contacts
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND search = '{{ search }}'
AND sort = '{{ sort }}'
AND state = '{{ state }}'
;