externalProjectsCursor
Gets a list of projects on external platform using cursor pagination
externalProjectsCursor(
companyId: ID!
integrationType: ToolTypeCategory!
filterName: String
pagination: CursorPaginationInput!
filters: ExternalProjectFiltersInput
): ExternalProjectsCursor
Arguments
externalProjectsCursor.companyId ● ID! non-null scalar
externalProjectsCursor.integrationType ● ToolTypeCategory! non-null enum
externalProjectsCursor.filterName ● String scalar
externalProjectsCursor.pagination ● CursorPaginationInput! non-null input
externalProjectsCursor.filters ● ExternalProjectFiltersInput input
Optional filters for external projects. Use the nested input matching your integration type.
Type
ExternalProjectsCursor 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
- JavaScript
- Python
curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetExternalProjectsCursor($companyId: ID!, $integrationType: ToolTypeCategory!, $pagination: CursorPaginationInput!) {\n externalProjectsCursor(companyId: $companyId, integrationType: $integrationType, pagination: $pagination) { next prev projects { id name branches } }\n}","variables":{"companyId":"<company_id>","integrationType":"CONVISO_AST","pagination":{}}}'
const response = await fetch('https://api.convisoappsec.com/graphql', {
method: 'POST',
headers: {
'content-type': 'application/json',
'x-api-key': process.env.CONVISO_API_KEY,
},
body: JSON.stringify({
query: "query GetExternalProjectsCursor($companyId: ID!, $integrationType: ToolTypeCategory!, $pagination: CursorPaginationInput!) {\n externalProjectsCursor(companyId: $companyId, integrationType: $integrationType, pagination: $pagination) { next prev projects { id name branches } }\n}",
variables: {
"companyId": "<company_id>",
"integrationType": "CONVISO_AST",
"pagination": {}
},
}),
});
const { data, errors } = await response.json();
if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);
import json
import os
import requests
response = requests.post(
'https://api.convisoappsec.com/graphql',
headers={
'content-type': 'application/json',
'x-api-key': os.environ['CONVISO_API_KEY'],
},
json={
'query': "query GetExternalProjectsCursor($companyId: ID!, $integrationType: ToolTypeCategory!, $pagination: CursorPaginationInput!) {\n externalProjectsCursor(companyId: $companyId, integrationType: $integrationType, pagination: $pagination) { next prev projects { id name branches } }\n}",
'variables': json.loads("{\"companyId\":\"<company_id>\",\"integrationType\":\"CONVISO_AST\",\"pagination\":{}}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute