Skip to main content

SearchHistoryResponse

items object[]required

Array of search history items

  • Array [
  • idstringrequired

    Search ID

    createdAtstring<date-time>nullable

    When the search was created (included only for admin role)

    thumbnailstring<uri>

    The searched face cropped from the uploaded photo, or the whole uploaded photo when no face crop is available. Photos in search history are never blurred as they are user's own uploads. Omitted when imageNotRetained is true, even while temporary image bytes still exist.

    titlestring

    Optional plain-text title captured on the first upload attempt. Render as text; when absent or blank, use a localized search date and short-ID fallback, never a filename.

    Possible values: <= 120 characters

    imageNotRetainedboolean

    Emitted only as true when this search's immutable policy disables uploaded-photo retention. Its thumbnail is omitted; render title or fallback without mounting an image. Absent means retained, independently of today's user policy.

    statusSearchStatus (string)required

    Search processing status

    Possible values: [processing, completed, error, preview]

    matchCountinteger<uint32>required

    Number of matches found

    hasResultsbooleanrequired

    Whether the search has results available (matches were selected and credit was deducted).

    • If true: user can directly access results (GET /search/{searchId}/results)
    • If false: user needs to select matches first (POST /search/{searchId}/select) before accessing results
    sourcesSource (string)[]

    Social networks where matches were found

    Possible values: [fb, ig, tt, tw, li]

  • ]
  • nextCursorstringnullable

    Cursor for the next page. If null, there are no more items available. Use this cursor in the next request with the same endpoint and limit parameter.

    totalinteger<uint32>

    Total number of items available. Optional field, may be omitted in additional pagination requests to reduce response size and improve performance.

    SearchHistoryResponse
    {
    "items": [
    {
    "id": "67489a2b3f4a210002",
    "createdAt": "2025-11-28T14:30:00Z",
    "thumbnail": "https://cdn.face2social.com/uploads/67489a2b3f4a210002_thumb.jpg",
    "status": "completed",
    "matchCount": 5,
    "hasResults": true
    }
    ],
    "nextCursor": "string",
    "total": 0
    }