Skip to main content

externalProjects

Gets a list of projects on external platform

externalProjects(
companyId: ID!
integrationType: ToolTypeCategory!
integrationId: ID
filterName: String
pagination: PaginationInput!
filters: ExternalProjectFiltersInput
): ExternalProjectCollection

Arguments​

externalProjects.companyId ● ID! non-null scalar​

externalProjects.integrationType ● ToolTypeCategory! non-null enum​

externalProjects.integrationId ● ID scalar​

Which integration of that type to list projects from. Required once the company has more than one (Salt Security allows N environments).

externalProjects.filterName ● String scalar​

externalProjects.pagination ● PaginationInput! non-null input​

externalProjects.filters ● ExternalProjectFiltersInput input​

Optional filters for external projects. Use the nested input matching your integration type.

Type​

ExternalProjectCollection object​

ExternalProjectCollection 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 GetExternalProjects($companyId: ID!, $integrationType: ToolTypeCategory!, $pagination: PaginationInput!) {\n externalProjects(companyId: $companyId, integrationType: $integrationType, pagination: $pagination) { collection { id name branches } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","integrationType":"CONVISO_AST","pagination":{}}}'

Contribute to the Docs

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

How to contribute