PIpipeshub-ai
Semantic Search

Get search by ID

Changed on

Retrieve a previously persisted search by its id, scoped to the caller's org. The caller must own the search or have it shared with them; archived searches are not returned.

The response body is always an array containing zero or one persisted search document. An unknown id, a search the caller cannot see, an archived search, or one that fails a query filter all return an empty array with a 200 status — this route never answers 404, so callers should check the array length.

The optional shared, startDate and endDate query filters are applied to the one search; search is validated but has no effect.

get/search/{searchId}

Request

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

Path parameters

searchIdstring objectId required

Unique search identifier

Query parameters

searchstring

Validated, then dropped: a stored search has no title to match, so it never filters anything. More than 1000 characters, or HTML markup, is refused with 400.

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

Return the search only if its isShared matches. 'true' / '1' and 'false' / '0', case-insensitive; anything else is refused with 400.

startDatestring

ISO 8601 date or date-time; return the search only if it was created on or after it. A value JavaScript's Date cannot parse is refused with 400.

endDatestring

ISO 8601 date or date-time; return the search only if it was created on or before it. A value JavaScript's Date cannot parse is refused with 400.

Response

Array containing zero or one persisted search document.

_idstring objectId required
__vinteger required
querystring required
limitinteger required
orgIdstring objectId required
userIdstring objectId required
recordsobject required

Map of source-record id (or _key) to a JSON-stringified record object. Clients must JSON.parse each value before reading fields.

isSharedboolean required
shareLinkstring

Set once the search has been shared via /search/{searchId}/share.

isArchivedboolean required
archivedBystring objectId nullable

User ID of the last user who archived this row, or null after an unarchive cleared the archive state. Absent on rows that have never been archived. Currently-archived rows cannot reach this endpoint because buildFilter enforces isArchived: false.

createdAtstring date-time required
updatedAtstring date-time required

Changes

  • dbb5e203b445Revision changes
    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • 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

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      removed the HTTP_FORBIDDEN enum value from the / response property for the response status

    • info

      removed the HTTP_INTERNAL_SERVER_ERROR enum value from the / response property for the response status

    • info

      removed the HTTP_UNAUTHORIZED enum value from the / response property for the response status

    • info

      removed the INTERNAL_ERROR enum value from the / response property for the response status

    • info

      removed the MIDDLEWARE_ERROR enum value from the / response property for the response status

    • info

      removed the VALIDATION_ERROR enum value from the / response property for the response status

  • a90ab79f26a1Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status