customFieldIntegration

Returns all custom fields by integration ID

customFieldIntegration(
  id: Int!
): CustomFieldIntegrationCollection

Arguments

customFieldIntegration.id ● Int! non-null scalar

Type

CustomFieldIntegrationCollection object

CustomFieldIntegrationCollection 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 GetCustomFieldIntegration($id: Int!) {\n  customFieldIntegration(id: $id) { collection { id name fieldType } metadata { currentPage limitValue totalCount } }\n}","variables":{"id":1}}'

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 GetCustomFieldIntegration($id: Int!) {\n  customFieldIntegration(id: $id) { collection { id name fieldType } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "id": 1
},
  }),
});

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 GetCustomFieldIntegration($id: Int!) {\n  customFieldIntegration(id: $id) { collection { id name fieldType } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"id\":1}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])