Skip to content
API Reference/
/
Create team

MVMNT API (1.0.0)

The MVMNT API enables you to automate freight brokerage workflows by integrating directly with our Transportation Management System.

Postman setup guide: API Clients.

Authentication

OAuth 2.0 client credentials flow. See Authentication Guide for details.

Token Endpoint

POST https://api.mvmnt.io/oauth2/token

Request

Headers:

Content-Type: application/x-www-form-urlencoded

Body Parameters:

grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

Example Request

curl -X POST https://api.mvmnt.io/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Success Response

Status: 200 OK

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Response Fields:

  • access_token: JWT Bearer token to use for API requests
  • token_type: Always Bearer
  • expires_in: Token lifetime in seconds (3600 = 1 hour)

Idempotency

Mutating requests (POST, PATCH, DELETE) accept an optional Idempotency-Key header (up to 255 characters). Retrying a request with the same key and the same body returns the original result instead of repeating the operation; reusing a key with a different body fails. Keys are scoped to your organization — keys chosen by other tenants can never collide with yours. Use a stable identifier from your system (for example your own record id plus the action) rather than a random value per attempt.

Download OpenAPI description
openapi.json
openapi.yaml
openapi-3.0.yaml (legacy tooling)
Postman Collection
Postman Environment — Demo
Postman Environment — Production
Overview
URL
https://docs.mvmnt.io
MVMNT Support
support@mvmnt.io
License
Proprietary
Languages
Servers
Production
https://api.mvmnt.io/v1
Demo (non-production)
https://api.demo.mvmnt.io/v1

Carriers

Carrier management operations

Operations

Carrier Contacts

Carrier contact management operations

Operations

Carrier Factors

Carrier factor (factoring company) management operations

Operations

Carrier Payment Methods

Carrier payment method management operations

Operations

Companies

Company management operations

Operations

Credit Memos

AR credit memo management operations. Credit memos represent customer credits that can be applied to invoices.

Operations

Bills

AP bill management operations. Bills represent carrier and vendor invoices to be paid.

Operations

Bill Payments

AP bill payment management operations. Bill payments record payments made to carriers and vendors.

Operations

Customers

Customer management operations

Operations

Customer Contacts

Customer contact management operations

Operations

Documents

Document management operations. Documents are files (PDFs, images) that can be attached to orders, loads, or services.

Operations

Invoices

AR invoice management operations. Invoices represent customer billing for shipment services.

Operations

Loads

Load management operations. Loads represent carrier execution - which carrier is moving the freight.

Operations

Locations

Location management operations

Operations

Location Contacts

Location contact management operations

Operations

Payment Terms

Payment term management operations

Operations

Reference Data

Read-only catalogs (equipment, charge codes, special requirements) referenced by id from other resources.

Every catalog also answers on its short top-level path, so GET /v1/charge-codes and GET /v1/reference-data/charge-codes are the same endpoint. The documented /reference-data/* form is canonical — it keeps the catalogs grouped here as more are added (port codes, cities, zip codes) — and the short form is a convenience alias.

Operations

Payments

AR payment management operations. Payments represent received customer payments applied to invoices.

Operations

Quotes

Quote management operations. Quotes are pricing requests/responses that can be converted to shipments.

Operations

Saved Searches

Saved search management operations

Operations

Services

Service (vended service) management operations. Services represent non-carrier vendor work (drayage, customs, warehousing).

Operations

Shipments

Shipment tracking and management operations. Shipments contain orders, loads, and services.

Operations

Teams

Team management operations

Operations

Filter teams

Request

Filter teams using comprehensive query criteria with AND/OR logic and multiple operators. Supports complex filtering similar to GraphQL capabilities. Note: Soft-deleted teams are excluded by default (deletedAt defaults to { isNull: true }).

Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(TeamFilter)

Filter criteria (optional - omit to return all teams). Note: deletedAt automatically defaults to { isNull: true } unless explicitly overridden.

Example: {"name":{"includes":"Sales"}}
pageSizeinteger[ 1 .. 250 ]

Number of results per page

Default 50
Example: 50
cursorstring

Pagination cursor for next page

curl -i -X POST \
  https://api.mvmnt.io/v1/teams/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "name": {
        "includes": "Sales"
      }
    },
    "pageSize": 50
  }'

Responses

Successful response

Bodyapplication/json
dataArray of objects(Team)
paginationobject(PaginationInfo)
Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}

Create team

Request

Create a new team in your organization

Security
BearerAuth
Bodyapplication/jsonrequired
namestringrequired

Team name (required)

Example: "Sales Team - West Coast"
keystring<= 512 characters

Client-defined reference identifier

Example: "ERP-TEAM-WEST"
usersArray of objects(ResourceReferenceInput)

Users to add to this team

Example: [{"id":"550e8400-e29b-41d4-a716-446655440000"},{"key":"ERP-USER-12345"}]
curl -i -X POST \
  https://api.mvmnt.io/v1/teams \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Sales Team - West Coast",
    "key": "ERP-TEAM-WEST",
    "users": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      },
      {
        "key": "ERP-USER-12345"
      }
    ]
  }'

Responses

Team created successfully

Bodyapplication/json
objectstringread-only

Object type identifier

Value"TEAM"
Example: "TEAM"
idstring(uuid)read-onlyrequired

Unique team identifier

Example: "123e4567-e89b-12d3-a456-426614174000"
namestringrequired

Team name

Example: "Sales Team - West Coast"
keystring or null<= 512 characters

Client-defined reference identifier for this team

Example: "ERP-TEAM-WEST"
usersArray of objects(users_UserReference)

Users who are members of this team

createdAtstring(date-time)read-onlyrequired

Timestamp when team was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

Timestamp when team was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

Timestamp when team was soft-deleted (null if active)

Example: null
Response
application/json
{
  "object": "TEAM",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Sales Team - West Coast",
  "key": "ERP-TEAM-WEST",
  "users": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Get team

Request

Retrieve a team by ID or client key

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Enum"id""key"
Example: by=key
curl -i -X GET \
  'https://api.mvmnt.io/v1/teams/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
objectstringread-only

Object type identifier

Value"TEAM"
Example: "TEAM"
idstring(uuid)read-onlyrequired

Unique team identifier

Example: "123e4567-e89b-12d3-a456-426614174000"
namestringrequired

Team name

Example: "Sales Team - West Coast"
keystring or null<= 512 characters

Client-defined reference identifier for this team

Example: "ERP-TEAM-WEST"
usersArray of objects(users_UserReference)

Users who are members of this team

createdAtstring(date-time)read-onlyrequired

Timestamp when team was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

Timestamp when team was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

Timestamp when team was soft-deleted (null if active)

Example: null
Response
application/json
{
  "object": "TEAM",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Sales Team - West Coast",
  "key": "ERP-TEAM-WEST",
  "users": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Update team

Request

Partially update a team. Only provided fields will be updated.

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Enum"id""key"
Example: by=key
Bodyapplication/jsonrequired
namestring

Team name

Example: "Sales Team - West Coast"
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-TEAM-WEST"
usersArray of objects(ResourceReferenceInput)

Team members (replaces all existing memberships)

Example: [{"id":"550e8400-e29b-41d4-a716-446655440000"},{"key":"ERP-USER-12345"}]
curl -i -X PATCH \
  'https://api.mvmnt.io/v1/teams/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Sales Team - West Coast",
    "key": "ERP-TEAM-WEST",
    "users": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      },
      {
        "key": "ERP-USER-12345"
      }
    ]
  }'

Responses

Team updated successfully

Bodyapplication/json
objectstringread-only

Object type identifier

Value"TEAM"
Example: "TEAM"
idstring(uuid)read-onlyrequired

Unique team identifier

Example: "123e4567-e89b-12d3-a456-426614174000"
namestringrequired

Team name

Example: "Sales Team - West Coast"
keystring or null<= 512 characters

Client-defined reference identifier for this team

Example: "ERP-TEAM-WEST"
usersArray of objects(users_UserReference)

Users who are members of this team

createdAtstring(date-time)read-onlyrequired

Timestamp when team was created

Example: "2025-01-15T10:00:00Z"
updatedAtstring(date-time)read-onlyrequired

Timestamp when team was last updated

Example: "2025-01-15T14:30:00Z"
deletedAtstring or null(date-time)read-only

Timestamp when team was soft-deleted (null if active)

Example: null
Response
application/json
{
  "object": "TEAM",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Sales Team - West Coast",
  "key": "ERP-TEAM-WEST",
  "users": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Delete team

Request

Soft delete a team (sets deletedAt timestamp)

Security
BearerAuth
Path
idstringrequired

Resource ID (UUID) or client key

Example: 550e8400-e29b-41d4-a716-446655440000
Query
bystring

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Enum"id""key"
Example: by=key
curl -i -X DELETE \
  'https://api.mvmnt.io/v1/teams/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Team deleted successfully

Response
No content

Users

User management operations

Operations

Vendors

Vendor management operations

Operations

Vendor Contacts

Vendor contact management operations

Operations

Vendor Payment Methods

Vendor payment method management operations

Operations

Event Notifications

Webhooks