Skip to main content

apiKey

Fetches a specific API key by ID

apiKey(
id: ID!
companyId: ID!
): ApiKey!

Arguments​

apiKey.id ● ID! non-null scalar​

apiKey.companyId ● ID! non-null scalar​

Type​

ApiKey object​

Company-scoped API Key metadata (token is never exposed)

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 GetApiKey($id: ID!, $companyId: ID!) {\n apiKey(id: $id, companyId: $companyId) { id name status }\n}","variables":{"id":"example-id","companyId":"<company_id>"}}'

Contribute to the Docs

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

How to contribute