Skip to main content
GET
/
api
/
property-definitions
/
search
Search Property Definitions
curl --request GET \
  --url https://api.merchantops.ai/api/property-definitions/search
{
  "items": [
    {
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "type": {},
      "aiCanAddANewValue": true,
      "aiMatchingGuidance": "<string>",
      "attributeConstraint": "<string>",
      "category": "<string>",
      "createdAt": "<string>",
      "createdBy": "<string>",
      "description": [
        {}
      ],
      "display_group": "<string>",
      "display_order": 0,
      "enrichment_config": {},
      "inputHint": "<string>",
      "isActive": true,
      "isFacetable": false,
      "isMultiValue": false,
      "isRequired": false,
      "isSearchable": false,
      "isVisibleInStorefront": true,
      "is_common": false,
      "is_entry_field": false,
      "is_system": false,
      "label": [
        {}
      ],
      "lastModifiedAt": "<string>",
      "lastModifiedBy": "<string>",
      "level": "<string>",
      "mustBeAccurateToAssign": false,
      "prompt_name": "<string>",
      "scope": "catalog",
      "ui_widget": "text_input",
      "valueCount": 0,
      "visibility": "list_and_detail"
    }
  ],
  "query": "<string>",
  "total": 123
}

Headers

authorization
string | null
X-Organization-ID
string | null

Query Parameters

q
string
required

Search query

limit
integer
default:50

Maximum results

Required range: 1 <= x <= 100

Cookies

stytch_session
string | null

Response

Successful Response

Response model for search results.

items
PropertyDefinitionResponse · object[]
required
query
string
required
total
integer
required