API ReferenceGraph

Retrieve a Graph Query

Retrieve a Graph Query

Path parameters

graph-query-idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Response

This endpoint returns a Graph Query object.
dataobject or null
A Graph Query object
includedlist of any or null

Excluded from the response by default. Will be an empty array when the include query parameter in the request was explicitly set to empty.

Errors