PIpipeshub-ai
Semantic Search

Unarchive a search

Changed on

Restore a previously archived search result back to the active search history. The owner or any user the search was shared with can unarchive it.

patch/search/{searchId}/unarchive

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/search/{searchId}/unarchive
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: semantic:write

Path parameters

searchIdstring objectId required

Unique search identifier

Query parameters

searchstring

Validated, then dropped: a stored search has no title to match, so the search is unarchived whatever this says. More than 1000 characters, or HTML markup, is refused with 400.

shared'true' | 'false' | '1' | '0'

Additional isShared filter. 'true' / '1' and 'false' / '0', case-insensitive; anything else is refused with 400. The search is only unarchived if it matches, otherwise 404.

startDatestring

ISO 8601 date or date-time lower bound for createdAt. The search is only unarchived if it was created on or after it, otherwise 404. A value JavaScript's Date cannot parse is refused with 400.

endDatestring

ISO 8601 date or date-time upper bound for createdAt. The search is only unarchived if it was created on or before it, otherwise 404. A value JavaScript's Date cannot parse is refused with 400.

Response

Search unarchived successfully

idstring objectId required

Unique identifier of the unarchived search.

status'unarchived' required

Resulting status of the search after the operation.

unarchivedBystring objectId required

User ID of the user who unarchived the search.

unarchivedAtstring date-time required

Timestamp when the search was unarchived.

Example response

{
  "id": "65f1c0a4e2b9c4d8f3a1b2c3",
  "status": "unarchived",
  "unarchivedBy": "65f1c0a4e2b9c4d8f3a1b2c4",
  "unarchivedAt": "2026-05-10T12:34:56.789Z",
  "meta": {
    "requestId": "req_8f3a1b2c",
    "timestamp": "2026-05-10T12:34:56.789Z",
    "duration": 42
  }
}

Changes

  • dbb5e203b445Revision changes
    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter shared

    • info

      added the new optional query request parameter startDate

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status