Skip to main content

customDashboardShareCandidates

Typeahead for the share dialog. Requires canShare. limit applies per kind (default 10, max 25).

customDashboardShareCandidates(
companyId: ID!
id: ID!
search: String
limit: Int = 10
): CustomDashboardShareCandidates!

Arguments​

customDashboardShareCandidates.companyId ● ID! non-null scalar​

customDashboardShareCandidates.id ● ID! non-null scalar​

customDashboardShareCandidates.limit ● Int scalar​

Type​

CustomDashboardShareCandidates object​

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetCustomDashboardShareCandidates($companyId: ID!, $id: ID!) {\n customDashboardShareCandidates(companyId: $companyId, id: $id) { teams { existingGrantId team { __typename } } users { existingGrantId maxRole user { __typename } } }\n}","variables":{"companyId":"<company_id>","id":"example-id"}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute