MVMNT Customers API is one of 28 APIs that MVMNT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes
8 operations
across 6 paths,
and defines 66 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.mvmnt.io/v1.
The identity and technical contract details declared by the specification.
CustomerFilter
object
Filter criteria for customers with AND/OR logic support
28 properties
AddressPatch
object
Partial address update. All fields are optional. - Omitted fields: Not modified (current value preserved) - Provided fields: Updated to the new value - Null va…
12 properties
CustomerSearchRequest
object
Request body for searching customers
5 properties
CustomerIndustry
string
Industry classification for the customer
SearchPaginationInfo
object
Pagination information for search results
3 properties
3 required
SearchPaginationInput
object
Pagination options for search requests
2 properties
Address
object
Physical address/location details (nested, without id). This is an embedded object representing a Location record. The id is managed internally and not exposed…
12 properties
8 required
CustomerCurrency
string
Preferred currency for transactions
CustomerAnnualRevenue
string
Annual revenue range
StringFilter
object
Filter options for string fields
11 properties
IntSearchCriteria
object
Search criteria for integer fields
4 properties
1 required
CustomerDeactivationReasonFilter
object
Filter options for CustomerDeactivationReason enum
5 properties
CustomerInput
object
39 properties
2 required
CustomerServiceTierFilter
object
Filter options for CustomerServiceTier enum
5 properties
OutstandingInvoicesResponse
object
2 properties
2 required
CustomerAnnualSpend
string
Annual freight spend estimate range
CustomerNumberOfEmployeesFilter
object
Filter options for CustomerNumberOfEmployees enum
5 properties
CustomerTransportationMode
string
Transportation mode type
CustomerTransportationModeFilter
object
Filter options for CustomerTransportationMode enum
5 properties
CustomerPatch
object
Partial customer update. All fields are optional. - Omitted fields: Not modified (current value preserved) - Provided fields: Updated to the new value - Null v…
39 properties
Error
object
2 properties
2 required
SearchSortOption
object
Sort option for search results
2 properties
2 required
KeywordSearchCriteria
object
Search criteria for keyword fields (exact match, no partial matching)
2 properties
1 required
PaymentTermReference
object
Enhanced reference to a payment term resource (returned in responses). Includes full payment term details in addition to id/key.
11 properties
4 required
CustomerReference
object
Enhanced reference to a customer resource (returned in responses). Includes full customer details in addition to id/key. Note: Does NOT include nested referenc…
10 properties
6 required
RelativeTimeUnit
string
Time unit for relative time calculations: - YEAR: Years - MONTH: Months - WEEK: Weeks - DAY: Days - HOUR: Hours - MINUTE: Minutes - SECOND: Seconds
CustomerSpendTypeFilter
object
Filter options for CustomerSpendType enum
5 properties
IDFilter
object
Filter options for ID fields (limited operations - exact match only)
2 properties
CustomerSearchCriteria
object
Search criteria for filtering customers. Note: Only active (non-deleted) customers are searchable. Soft-deleted records are automatically excluded.
44 properties
CustomerAnnualSpendFilter
object
Filter options for CustomerAnnualSpend enum
5 properties
ShowNotes
string
Controls whether external notes are shown on all documents or split from carrier-facing notes. - ALL: Use external notes on customer-facing and carrier-facing…
CustomerStatusFilter
object
Filter options for CustomerStatus enum
5 properties
DatetimeSearchCriteria
object
Search criteria for datetime fields. Supports both absolute datetime values and relative time expressions.
10 properties
1 required
CustomerContactNotificationType
string
Types of shipment notifications the contact should receive
ClientKeyFilter
object
Filter options for client key fields (limited operations - exact match only)
3 properties
Customer
object
50 properties
6 required
CustomerCurrencyFilter
object
Filter options for CustomerCurrency enum
5 properties
Payment
object
18 properties
4 required
TextSearchCriteria
object
Search criteria for text fields (supports wildcards and partial matching)
2 properties
1 required
CustomerSpendType
string
Customer spend type: - CONTRACT: Customer operates under contract pricing - SPOT: Customer operates on spot market pricing
CustomerAnnualRevenueFilter
object
Filter options for CustomerAnnualRevenue enum
5 properties
CustomerSearchResponse
object
Response for customer search requests. Note: Only active (non-deleted) customers are included in results.
3 properties
3 required
CustomerServiceTier
string
Service tier level for the customer
DatetimeFilter
object
Filter options for datetime fields
7 properties
CustomerNumberOfEmployees
string
Number of employees in the company
PaymentCreditApplication
object
4 properties
CustomerIndustryFilter
object
Filter options for CustomerIndustry enum
5 properties
AddressInput
object
Address data for creating a new location
12 properties
4 required
ResourceReference
object
Reference to another resource (returned in responses)
2 properties
1 required
CustomerSearchRow
object
Flattened customer data from search index. Note: This represents only active customers. Soft-deleted records are never returned.
45 properties
7 required
CustomerContactReference
object
Customer contact reference for embedding in Customer responses. Identical to CustomerContact but excludes the customer and customerId fields to avoid circular…
13 properties
5 required
UserReference
object
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key. Note: Does NOT include nested references (team…
11 properties
5 required
ValidationError
object
3 properties
3 required
SavedSearchLookup
object
Reference to a saved search by ID or client key. Provide either id or key (not both).
2 properties
CustomerDeactivationReason
string
Reason for customer deactivation: - NOTPAYINGINVOICE: Customer is not paying invoices - ACQUIRED: Customer was acquired by another company - DUPLICATE: Duplica…
ResourceReferenceInput
object
Reference to another resource by either ID or client key (used in create/update requests)
2 properties
CustomerContactType
string
Type of customer contact role
CustomerStatus
string
Customer account status (includes lead stages): - NEW: New lead, not yet contacted - CONTACTED: Initial contact made with lead - QUALIFIED: Lead has been quali…
FloatSearchCriteria
object
Search criteria for float/decimal fields
4 properties
1 required
payments_PaymentMethodType
string
Payment method type. - ACHWIRE: ACH or wire transfer - ZELLE: Zelle payment - VENMO: Venmo payment - CHECK: Paper check - EFTDIRECTDEPOSIT: EFT direct deposit…
DateSearchCriteria
object
Search criteria for date fields (no time component). Supports both absolute date values and relative time expressions.
10 properties
1 required
ContactInfo
object
Contact information details (nested, without id). This is an embedded object representing a Contact record. The id is managed internally and not exposed in the…
4 properties
1 required
PaymentApplication
object
6 properties
3 required
CustomerFilterRequest
object
Request body for filtering customers
3 properties
PaginationInfo
object
4 properties
2 required
UUIDSearchCriteria
object
Search criteria for UUID fields
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MVMNT publishes across the network.