Skip to main content

Documentation index: llms.txt. This page is also available as markdown: append .md to this URL or send Accept: text/markdown.

GetTermsOutput

Paginated response from the executed query or mutation

type GetTermsOutput {
  greatestId: String
  nbPerPage: Int!
  page: Int
  totalCount: Int!
  data: [Term!]!
}

Fields​

GetTermsOutput.greatestId ● String scalar general​

The greatest id returned, to pass as the next 'greaterThanId' when using cursor-based pagination. Returned only when page is not used.

GetTermsOutput.nbPerPage ● Int! non-null scalar general​

Number of entities to return per page

GetTermsOutput.page ● Int scalar general​

The page number (start at 0). Returned only when greaterThanId is not used.

GetTermsOutput.totalCount ● Int! non-null scalar general​

The total number of entities

GetTermsOutput.data ● [Term!]! non-null object terms-knowledge​

Field containing the response from the executed query or mutation

Example​

{
  "greatestId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "nbPerPage": 50,
  "page": 0,
  "totalCount": 100,
  "data": [
    {
      "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "deprecatedAt": 1758555879800,
      "depthLevel": 0,
      "descriptionRaw": "Information about our **customers**",
      "descriptionStateLexical": {
        "root": {
          "children": [
            {
              "type": "paragraph",
              "version": 1
            }
          ],
          "direction": null,
          "format": "",
          "indent": 0,
          "type": "root",
          "version": 1
        }
      },
      "externalDescription": "All stored information about customers",
      "externalDescriptionSource": "KNOWLEDGE",
      "externalId": "page/all-stored-information-about-customers",
      "icon": "🤖",
      "isDescriptionGenerated": false,
      "lastEditedAt": 1758555879800,
      "name": "Customers",
      "slug": "term-customers",
      "url": "https://notion.io/all-stored-information-about-customers",
      "verifiedAt": 1758555879800,
      "childrenTerms": [],
      "deprecatedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "entityEditors": [
        {
          "dashboardId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "sourceUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "sourceUser": {
            "avatarUrl": "https://example.com/avatar.png",
            "email": "john.doe@example.com",
            "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "unifiedId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "unifiedUser": {
              "role": "CONTRIBUTOR",
              "status": "ACTIVATED",
              "teamIds": [
                "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
              ],
              "userId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
              "createdAt": 1758555879800
            },
            "deletedAt": 1758555879800,
            "updatedAt": 1758555879800
          },
          "tableId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "termId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "refreshedAt": 1758555879800
        }
      ],
      "lastDescribedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "lastDescribedBy": {
        "firstName": "John",
        "lastName": "Doe",
        "ownerEntities": [
          {
            "ownerLabelId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "ownerLabel": {
              "label": "Data Steward"
            }
          }
        ],
        "fullName": "John Doe"
      },
      "linkedTag": {
        "color": "ALERT_COLOR",
        "linkedTermId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
      },
      "ownerEntities": [],
      "parentTermId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "tagEntities": [
        {
          "origin": "USER",
          "technology": "COALESCE",
          "tagId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
        }
      ],
      "teamOwnerEntities": [
        {
          "teamId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "team": {
            "description": "Members of the EMEA sales team",
            "slackChannel": "#emea-sales",
            "slackGroup": "@emea-sales",
            "source": "Slack",
            "teamOwnerEntities": []
          }
        }
      ],
      "verifiedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
      "isDeprecated": false,
      "isVerified": false
    }
  ]
}

Returned By​