API Call

Squid supports HTTP GET requests and returns JSON.

Request

The URL is https://yourinstance/api/x_a46gh_squidx/v1/data/{configName} where {configName} is the name of the configuration you are requesting. Configurations define what data is returned—for example, cmdb_ci_server returns all server CIs. See Predefined Configurations for available configurations.

Query parameters refine requests: filter results, request specific entities, include relations, and toggle output features.

Try it: https://demo.squid46.io/cmdb_ci_server_minimal?limit=10

info

The demo server is proxied and rate-limited. If you're getting HTTP 429s, slow down! (This is only an issue on the publicly available demo server.)

To keep URLs shorter and more readable, all links to https://demo.squid46.io omit the /api/x_a46gh_squidx/v1/data/ path segment.

Response

Every Squid response contains four sections:

• metadata — Request information, timing, and filter details
• data — Array of requested entities
• relations — Related entities, organized by parent sys_id
• referenced — Complete data for all referenced and related entities

This structure avoids data duplication: an entity referenced multiple times appears once in referenced.

Relations

Resolving references and relations is the added value of Squid. References are resolved by default and do not have to be explicitly requested. Relations require additional database queries and are only resolved if requested.

Squid supports three different types of relations:

See Predefined Relations for an overview of all predefined relations provided by Squid.

relations

Relations are requested as query parameter relations. Squid accepts this parameter in various formats:

• relations=rel1,rel2,rel3
• relations=rel1&relations=rel2&relations=rel3
• relations=rel1,rel2&relations=rel3

Use whatever fits your calling application best.

Depending on your configurations, relations may be rendered in various ways. See RenderTypes for Relations for details on all available options, including Relation types and Inline types.

The key distinction is where related data appears in the response:

Relation

Relations are rendered not in the parent JSON object, but in a dedicated relations property. See RenderType Relation* for details.

Try it: https://demo.squid46.io/cmdb_ci_server_minimal?encodedQuery=base_name=web-prod-zurich-01&relations=ci_to_user_group_dynamic

Response

{
  ...,
  "data": [
    {
      "name": "web-prod-zurich-01",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "da9b0e66ebf67254f0a4fe7acad0cdf3",         <= sys_id of requested server
      "sys_mod_count": 1,
      "sys_updated_on": "2026-02-04T14:30:00Z"
    }
  ],
  "relations": {
    "da9b0e66ebf67254f0a4fe7acad0cdf3": {                   <= sys_id of requested server
      "managed_by": [                                       <= dynamic property name
        {
          "sys_id": "81339666eb3a7254f0a4fe7acad0cdba",     <= sys_id of user group
          "sys_class_name": "sys_user_group"
        }
      ],
      "change": [                                           <= dynamic property name
        {
          "sys_id": "81339666eb3a7254f0a4fe7acad0cdba",     <= same group, different role
          "sys_class_name": "sys_user_group"
        }
      ],
      "support": [                                          <= dynamic property name
        {
          "sys_id": "01335a66eb3a7254f0a4fe7acad0cd4e",     <= sys_id of user group
          "sys_class_name": "sys_user_group"
        }
      ],
      "approval": [                                         <= dynamic property name
        {
          "sys_id": "a715cd759f2002002920bde8132e7018",     <= sys_id of user group
          "sys_class_name": "sys_user_group"
        }
      ]
    }
  },
  "referenced": {                                           <= each group resolved once
    "81339666eb3a7254f0a4fe7acad0cdba": {                   <= managed_by + change
      "active": true,
      "description": "Infrastructure operations team ...",
      "name": "IT Infrastructure",
      "sys_created_by": "ferret",
      "sys_created_on": "2026-02-04T15:01:46Z",
      "sys_id": "81339666eb3a7254f0a4fe7acad0cdba",
      "sys_mod_count": 0,
      "sys_updated_by": "ferret",
      "sys_updated_on": "2026-02-04T15:01:46Z"
    },
    "01335a66eb3a7254f0a4fe7acad0cd4e": {                   <= support
      "name": "IT Service Desk",
      ...
    },
    "a715cd759f2002002920bde8132e7018": {                   <= approval
      "name": "Change Management",
      ...
    }
  }
}

Inline

Inline relations are rendered as properties of the enclosing JSON object.

Rendering relations inline may have an extreme performance impact. See RenderType Inline* for details.

Try it: https://demo.squid46.io/cmdb_ci_server_inline_minimal?encodedQuery=base_name=web-prod-zurich-01&relations=ci_to_user_group_inline

Response

{
  ...,
  "data": [
    {
      "name": "web-prod-zurich-01",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "da9b0e66ebf67254f0a4fe7acad0cdf3",
      "sys_mod_count": 1,
      "sys_updated_on": "2026-02-04T14:30:00Z",
      "user_groups": [                                      <= ci_to_user_group_inline
        {
          "active": true,
          "description": "Infrastructure operations team ...",
          "name": "IT Infrastructure",
          "sys_id": "81339666eb3a7254f0a4fe7acad0cdba",     <= sys_id of user group
          "sys_mod_count": 0,
          ...
        },
        {
          "active": true,
          "description": "First-line support for end-user issues",
          "name": "IT Service Desk",
          "sys_id": "01335a66eb3a7254f0a4fe7acad0cd4e",     <= sys_id of user group
          "sys_mod_count": 0,
          ...
        },
        ...
      ]
    }
  ],
  "relations": {},                                          <= empty — relations are inline
  "referenced": {}                                          <= empty — entities are inline
}

{configName}.relations

The relations parameter only resolves relations for root entities. To add relations to referenced or related entities — for example, resolving users for each user group — use:

{configName}.relations=relationName

This tells Squid: "whenever you render an entity using {configName}, also resolve these relations."

Example: Fetch a server with its user groups inline, and resolve the users for each group:

Try it: https://demo.squid46.io/cmdb_ci_server_inline_minimal?encodedQuery=base_name=web-prod-zurich-01&relations=ci_to_user_group_dynamic_inline&sys_user_group_inline.relations=user_group_to_user_inline_minimal

• relations=ci_to_user_group_dynamic_inline — adds user groups inline to the server
• sys_user_group_inline.relations=user_group_to_user_inline_minimal — adds users inline to each group rendered with the sys_user_group_inline configuration

Without the second parameter, the groups would appear without their users.

Response (trimmed)

{
  ...,
  "data": [
    {
      "name": "web-prod-zurich-01",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "da9b0e66ebf67254f0a4fe7acad0cdf3",
      ...,
      "managed_by": [                                        <= inline user group
        {
          "name": "IT Infrastructure",
          "sys_id": "81339666eb3a7254f0a4fe7acad0cdba",
          ...,
          "users": [                                         <= inline users
            {
              "name": "Michael Weber",
              "email": "michael.weber@example.com",
              "sys_id": "bb135666eb3a7254f0a4fe7acad0cd37",
              ...
            },
            {
              "name": "Sarah Johnson",
              ...
            },
            ...
          ]
        }
      ],
      "change": [...],
      "support": [...],
      "approval": [...]
    }
  ],
  "relations": {},                                           <= empty — all relations are inline
  "referenced": {}                                           <= empty — all entities are inline
}

As with relations, Squid accepts this parameter in various formats:

• configName.relations=rel1,rel2,rel3
• configName.relations=rel1&configName.relations=rel2

See Recursive Structures for an advanced use case with nested parent-child hierarchies.

Filters

Most use cases require filtering to retrieve a specific subset of data.

See Filters for all filter parameters: encodedQuery, sys_id, timestamp filters, filterOnTags, filterOnTeams, and limit.

Flags

Flags are query parameters that turn on features.

See Flags for all available flags: showBlank, showTags, showTagsInline, preservePrefix, showConfig, metaData, and lenient.