Search objects by handle

GET/api/objects/by-handle/{handle}/search

Performs lightweight search within one object handle.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"projects"

Query Parameters

query*string

Query string or search text supplied by the caller.

Example"airport"

Response Body

`application/json`

curl -X GET "https://loading/api/objects/by-handle/projects/search?query=airport"

[
  {
    "id": "objrec_123",
    "name": "Airport Expansion",
    "subtitle": "Active opportunity",
    "iconUrl": "https://www.google.com/s2/favicons?domain=github.com&sz=64"
  }
]

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Search objects by handle

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`