Skip to main content

apiKeys

Lists API keys by company

apiKeys(
companyId: ID!
teamId: ID
status: [ApiKeyStatusEnum!] = [ACTIVE, EXPIRED]
type: ApiKeyTypeEnum
page: Int = 1
limit: Int = 10
): ApiKeyCollection!

Arguments​

apiKeys.companyId ● ID! non-null scalar​

apiKeys.teamId ● ID scalar​

apiKeys.status ● [ApiKeyStatusEnum!] list enum​

apiKeys.type ● ApiKeyTypeEnum enum​

apiKeys.page ● Int scalar​

apiKeys.limit ● Int scalar​

Type​

ApiKeyCollection object​

ApiKeyCollection type

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 GetApiKeys($companyId: ID!) {\n apiKeys(companyId: $companyId) { collection { id name status } metadata { currentPage limitValue totalCount } }\n}","variables":{"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