teamsByScope

Returns teams available to the company

teamsByScope(
  id: ID!
  page: Int
  limit: Int
  params: TeamSearch
  orderType: OrderParams
  order: OrderTeamsParams
): TeamCollection

Arguments

teamsByScope.id ● ID! non-null scalar

teamsByScope.page ● Int scalar

teamsByScope.limit ● Int scalar

teamsByScope.params ● TeamSearch input

teamsByScope.orderType ● OrderParams enum

teamsByScope.order ● OrderTeamsParams enum

Type

TeamCollection object

TeamCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetTeamsByScope($id: ID!) {\n  teamsByScope(id: $id) { collection { id label accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"id":"example-id"}}'

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 GetTeamsByScope($id: ID!) {\n  teamsByScope(id: $id) { collection { id label accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "id": "example-id"
},
  }),
});

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 GetTeamsByScope($id: ID!) {\n  teamsByScope(id: $id) { collection { id label accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"id\":\"example-id\"}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])