Saved Searches

Create saved search

Changed on

Create a new saved search configuration in your organization. The saved search can be used to quickly apply predefined search criteria, sorting, and display preferences.

The saved search will be owned by the authenticated user unless otherwise specified.

post/saved-searches

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/saved-searches
  • Auth: HTTP bearer

Request body

namestring required

Display name for the saved search (required)

preferenceType'SHIPMENT' | 'INVOICE' | 'BILL' | 'USER' | 'CUSTOMER' | 'VENDOR' | 'QUOTE' | 'COMMISSION' | 'CARRIER' | 'INVOICE_PAYMENT' | 'BILL_PAYMENT' | 'LOAD' | 'TRUCK_POSTING' | 'LOCATION' | 'CARRIER_FACTOR' | 'COMMISSION_PAYMENT' | 'AR_CREDIT_MEMO' | 'AP_CREDIT_MEMO' required

Type of entity this saved search applies to. Each type corresponds to a specific entity's search view.

Entity Mapping:

  • INVOICE: Customer invoices (AR Invoices) - money owed to you
  • BILL: Vendor/Carrier bills (AP Invoices) - money you owe
  • INVOICE_PAYMENT: Customer payment groups (AR Payment Groups)
  • BILL_PAYMENT: Vendor/Carrier payment groups (AP Payment Groups)
isPublicboolean

Whether this saved search is visible to all users in the organization

groupIdstring uuid

Optional group this saved search belongs to

Example request

{
  "name": "Active Shipments - West Coast",
  "preferenceType": "SHIPMENT",
  "jsonValue": {
    "searchCriteria": {
      "filters": [
        {
          "field": "status",
          "searchCriteria": {
            "operator": "ONE_OF",
            "values": [
              "ACTIVE",
              "PENDING"
            ]
          }
        }
      ]
    },
    "sorting": [
      {
        "id": "createdAt",
        "desc": true
      }
    ]
  },
  "isPublic": true
}

Response

Saved search created successfully

object'SAVED_SEARCH'

Object type identifier

idstring uuid required

Unique saved search identifier

namestring required

Display name for the saved search

preferenceType'SHIPMENT' | 'INVOICE' | 'BILL' | 'USER' | 'CUSTOMER' | 'VENDOR' | 'QUOTE' | 'COMMISSION' | 'CARRIER' | 'INVOICE_PAYMENT' | 'BILL_PAYMENT' | 'LOAD' | 'TRUCK_POSTING' | 'LOCATION' | 'CARRIER_FACTOR' | 'COMMISSION_PAYMENT' | 'AR_CREDIT_MEMO' | 'AP_CREDIT_MEMO' required

Type of entity this saved search applies to. Each type corresponds to a specific entity's search view.

Entity Mapping:

  • INVOICE: Customer invoices (AR Invoices) - money owed to you
  • BILL: Vendor/Carrier bills (AP Invoices) - money you owe
  • INVOICE_PAYMENT: Customer payment groups (AR Payment Groups)
  • BILL_PAYMENT: Vendor/Carrier payment groups (AP Payment Groups)
isPublicboolean nullable

Whether this saved search is visible to all users in the organization. If false or null, only the owner can see it.

ownedByUserstring uuid nullable

User ID who owns this saved search. Null means it's an organization-level saved search.

groupIdstring uuid nullable

Optional group this saved search belongs to

createdAtstring date-time required

Timestamp when saved search was created

updatedAtstring date-time required

Timestamp when saved search was last updated

Example response

{
  "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"
}

Changes

    • breaking

      the response's body 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

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      the optional response header X-RateLimit-Reset removed for the status 429

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response 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 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 the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • warning

      added the new AP_CREDIT_MEMO enum value to the //// response property for the response status

    • warning

      added the new AR_CREDIT_MEMO enum value to the //// response property for the response status

    • warning

      added the new CARRIER_FACTOR enum value to the //// response property for the response status

    • warning

      added the new COMMISSION_PAYMENT enum value to the //// response property for the response status

    • info

      added the new AP_CREDIT_MEMO enum value to the request property ////

    • info

      added the new AR_CREDIT_MEMO enum value to the request property ////

    • info

      added the new CARRIER_FACTOR enum value to the request property ////

    • info

      added the new COMMISSION_PAYMENT enum value to the request property ////