Suggestions

Search data structure suggestions

post

Returns suggested data structures based on the provided query and search parameters, respecting caller permissions.

Body

querystring · nullableOptional

Search query text

sizeinteger · min: 1 · nullableOptional

Number of suggestions to return

Default: 10

Other propertiesanyOptional

Responses

200

Data structure suggestions

application/json

scroll_idstring · nullableOptional

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post/api/data_structures/suggestions

POST /api/data_structures/suggestions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "query": "customer",
  "resource": {
    "id": 1,
    "type": "concepts",
    "version": 1
  },
  "size": 10
}

{
  "data": [
    {
      "domain_ids": [
        101
      ],
      "external_id": "ds_customer_email",
      "id": 123,
      "inserted_at": "2026-06-10T10:00:00Z",
      "metadata": {
        "description": "some description"
      },
      "name": "customer_email",
      "system": {
        "external_id": "sys1",
        "id": 1,
        "name": "System1"
      },
      "type": "Table",
      "updated_at": "2026-06-10T10:00:00Z",
      "version": 0
    }
  ],
  "filters": {
    "domain": [
      {
        "count": 1,
        "key": 101
      }
    ]
  },
  "scroll_id": null
}