snykOrganizations

Gets a list of organizations on Snyk platform

snykOrganizations(
  companyId: ID!
  name: String
  pagination: CursorPaginationInput!
): SnykOrganizations

Arguments

snykOrganizations.companyId ● ID! non-null scalar

snykOrganizations.name ● String scalar

snykOrganizations.pagination ● CursorPaginationInput! non-null input

Type

SnykOrganizations 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

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetSnykOrganizations($companyId: ID!, $pagination: CursorPaginationInput!) {\n  snykOrganizations(companyId: $companyId, pagination: $pagination) { next organizations { id name } }\n}","variables":{"companyId":"<company_id>","pagination":{}}}'

JavaScript

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 GetSnykOrganizations($companyId: ID!, $pagination: CursorPaginationInput!) {\n  snykOrganizations(companyId: $companyId, pagination: $pagination) { next organizations { id name } }\n}",
    variables: {
    "companyId": "<company_id>",
    "pagination": {}
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

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 GetSnykOrganizations($companyId: ID!, $pagination: CursorPaginationInput!) {\n  snykOrganizations(companyId: $companyId, pagination: $pagination) { next organizations { id name } }\n}",
        'variables': json.loads("{\"companyId\":\"<company_id>\",\"pagination\":{}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])