v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Saved Searches

Filter saved searches

Filter saved searches using comprehensive query criteria with AND/OR logic and multiple operators. Supports complex filtering similar to GraphQL capabilities. Returns only saved searches accessible to the authenticated user (either owned by them or public).

post/saved-searches/filter

Request body

pageSizeinteger

Number of results per page

cursorstring

Pagination cursor for next page

Example request

{
  "filter": {
    "preferenceType": {
      "equalTo": "SHIPMENT"
    },
    "isPublic": {
      "equalTo": true
    }
  },
  "pageSize": 50
}

Response

Successful response

Example response

{
  "data": [
    {
      "object": "SAVED_SEARCH",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Active Shipments - West Coast",
      "preferenceType": "SHIPMENT",
      "jsonValue": {
        "searchCriteria": {
          "filters": [
            {
              "field": "status",
              "searchCriteria": {
                "operator": "ONE_OF",
                "values": [
                  "ACTIVE",
                  "PENDING"
                ]
              }
            }
          ]
        },
        "sorting": [
          {
            "id": "createdAt",
            "desc": true
          }
        ],
        "columnVisibility": {
          "status": true,
          "createdAt": true
        },
        "columnOrder": [
          "id",
          "status",
          "createdAt"
        ]
      },
      "isPublic": true,
      "ownedByUser": "550e8400-e29b-41d4-a716-446655440001",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}