Skip to content
API Reference/
/
Create user

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

Users

User management operations

Operations

Filter users

Request

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

Security
BearerAuth
Bodyapplication/jsonrequired
filterobject(UserFilter)

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

Example: {"and":[{"status":{"equalTo":"ACTIVE"}},{"roles":{"contains":"CUSTOMER_REP"}},{"email":{"includes":"@example.com"}}]}
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/users/filter \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "and": [
        {
          "status": {
            "equalTo": "ACTIVE"
          }
        },
        {
          "roles": {
            "contains": "CUSTOMER_REP"
          }
        },
        {
          "email": {
            "includes": "@example.com"
          }
        }
      ]
    },
    "pageSize": 50
  }'

Responses

Successful response

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

Create user

Request

Create a new user in your organization

Security
BearerAuth
Bodyapplication/jsonrequired
emailstring(email)required

User's email address (required)

Example: "john.doe@example.com"
namestring

User's full name

Example: "John Doe"
phonestring

User's phone number

Example: "+1-555-123-4567"
phoneExtstring

Phone extension

Example: "123"
statusstring(UserStatus)required

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
Enum"PENDING""ACTIVE""INACTIVE"
rolesArray of strings(UserRole)non-emptyrequired

User's roles within the organization (required)

Items Enum"CUSTOMER_REP""CARRIER_REP""AR_AP""COMPLIANCE""MANAGER""ADMIN"
Example: ["CUSTOMER_REP"]
keystring<= 512 characters

Client-defined reference identifier

Example: "ERP-USER-12345"
datUsernamestring

DAT (Load Board) integration username

Example: "johndoe_dat"
mcpUsernamestring

MyCarrierPortal integration username

Example: "johndoe_mcp"
avatarIdstring(uuid)

Profile avatar document ID

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
teamsArray of objects(ResourceReferenceInput)

Teams to add this user to

Example: [{"id":"123e4567-e89b-12d3-a456-426614174000"},{"key":"TEAM-WEST-COAST"}]
curl -i -X POST \
  https://api.mvmnt.io/v1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "PENDING",
    "roles": [
      "CUSTOMER_REP"
    ],
    "key": "ERP-USER-12345",
    "datUsername": "johndoe_dat",
    "mcpUsername": "johndoe_mcp",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "teams": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      {
        "key": "TEAM-WEST-COAST"
      }
    ]
  }'

Responses

User created successfully

Bodyapplication/json
objectstringread-only

Object type identifier

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

Unique user identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
emailstring(email)required

User's email address

Example: "john.doe@example.com"
namestring or null

User's full name

Example: "John Doe"
phonestring or null

User's phone number

Example: "+1-555-123-4567"
phoneExtstring or null

Phone extension

Example: "123"
statusstring(UserStatus)required

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
Enum"PENDING""ACTIVE""INACTIVE"
rolesArray of strings(UserRole)required

User's roles within the organization

Items Enum"CUSTOMER_REP""CARRIER_REP""AR_AP""COMPLIANCE""MANAGER""ADMIN"
Example: ["CUSTOMER_REP","ADMIN"]
keystring or null<= 512 characters

Client-defined reference identifier for this user

Example: "ERP-USER-12345"
datUsernamestring or null

DAT (Load Board) integration username

Example: "johndoe_dat"
mcpUsernamestring or null

MyCarrierPortal integration username

Example: "johndoe_mcp"
avatarIdstring or null(uuid)

Profile avatar document ID

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
teamsArray of objects(TeamReference)

Teams this user belongs to

createdAtstring(date-time)read-onlyrequired

Timestamp when user was created

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

Timestamp when user was last updated

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

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

Example: null
Response
application/json
{
  "object": "USER",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "phone": "+1-555-123-4567",
  "phoneExt": "123",
  "status": "PENDING",
  "roles": [
    "CUSTOMER_REP",
    "ADMIN"
  ],
  "key": "ERP-USER-12345",
  "datUsername": "johndoe_dat",
  "mcpUsername": "johndoe_mcp",
  "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "teams": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Get user

Request

Retrieve a user 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/users/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
objectstringread-only

Object type identifier

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

Unique user identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
emailstring(email)required

User's email address

Example: "john.doe@example.com"
namestring or null

User's full name

Example: "John Doe"
phonestring or null

User's phone number

Example: "+1-555-123-4567"
phoneExtstring or null

Phone extension

Example: "123"
statusstring(UserStatus)required

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
Enum"PENDING""ACTIVE""INACTIVE"
rolesArray of strings(UserRole)required

User's roles within the organization

Items Enum"CUSTOMER_REP""CARRIER_REP""AR_AP""COMPLIANCE""MANAGER""ADMIN"
Example: ["CUSTOMER_REP","ADMIN"]
keystring or null<= 512 characters

Client-defined reference identifier for this user

Example: "ERP-USER-12345"
datUsernamestring or null

DAT (Load Board) integration username

Example: "johndoe_dat"
mcpUsernamestring or null

MyCarrierPortal integration username

Example: "johndoe_mcp"
avatarIdstring or null(uuid)

Profile avatar document ID

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
teamsArray of objects(TeamReference)

Teams this user belongs to

createdAtstring(date-time)read-onlyrequired

Timestamp when user was created

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

Timestamp when user was last updated

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

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

Example: null
Response
application/json
{
  "object": "USER",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "phone": "+1-555-123-4567",
  "phoneExt": "123",
  "status": "PENDING",
  "roles": [
    "CUSTOMER_REP",
    "ADMIN"
  ],
  "key": "ERP-USER-12345",
  "datUsername": "johndoe_dat",
  "mcpUsername": "johndoe_mcp",
  "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "teams": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Update user

Request

Partially update a user. 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
emailstring(email)

User's email address

Example: "john.doe@example.com"
namestring or null

User's full name

Example: "John Doe"
phonestring or null

User's phone number

Example: "+1-555-123-4567"
phoneExtstring or null

Phone extension

Example: "123"
statusstring(UserStatus)

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
Enum"PENDING""ACTIVE""INACTIVE"
rolesArray of strings(UserRole)non-empty

User's roles (replaces all existing roles)

Items Enum"CUSTOMER_REP""CARRIER_REP""AR_AP""COMPLIANCE""MANAGER""ADMIN"
Example: ["CUSTOMER_REP","ADMIN"]
keystring or null<= 512 characters

Client-defined reference identifier

Example: "ERP-USER-12345"
datUsernamestring or null

DAT integration username

Example: "johndoe_dat"
mcpUsernamestring or null

MyCarrierPortal integration username

Example: "johndoe_mcp"
avatarIdstring or null(uuid)

Profile avatar document ID

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
teamsArray of objects(ResourceReferenceInput)

Teams this user belongs to (replaces all existing team memberships)

Example: [{"id":"123e4567-e89b-12d3-a456-426614174000"},{"key":"TEAM-WEST-COAST"}]
curl -i -X PATCH \
  'https://api.mvmnt.io/v1/users/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "PENDING",
    "roles": [
      "CUSTOMER_REP",
      "ADMIN"
    ],
    "key": "ERP-USER-12345",
    "datUsername": "johndoe_dat",
    "mcpUsername": "johndoe_mcp",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "teams": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      {
        "key": "TEAM-WEST-COAST"
      }
    ]
  }'

Responses

User updated successfully

Bodyapplication/json
objectstringread-only

Object type identifier

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

Unique user identifier

Example: "550e8400-e29b-41d4-a716-446655440000"
emailstring(email)required

User's email address

Example: "john.doe@example.com"
namestring or null

User's full name

Example: "John Doe"
phonestring or null

User's phone number

Example: "+1-555-123-4567"
phoneExtstring or null

Phone extension

Example: "123"
statusstring(UserStatus)required

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
Enum"PENDING""ACTIVE""INACTIVE"
rolesArray of strings(UserRole)required

User's roles within the organization

Items Enum"CUSTOMER_REP""CARRIER_REP""AR_AP""COMPLIANCE""MANAGER""ADMIN"
Example: ["CUSTOMER_REP","ADMIN"]
keystring or null<= 512 characters

Client-defined reference identifier for this user

Example: "ERP-USER-12345"
datUsernamestring or null

DAT (Load Board) integration username

Example: "johndoe_dat"
mcpUsernamestring or null

MyCarrierPortal integration username

Example: "johndoe_mcp"
avatarIdstring or null(uuid)

Profile avatar document ID

Example: "7c9e6679-7425-40de-944b-e07fc1f90ae7"
teamsArray of objects(TeamReference)

Teams this user belongs to

createdAtstring(date-time)read-onlyrequired

Timestamp when user was created

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

Timestamp when user was last updated

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

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

Example: null
Response
application/json
{
  "object": "USER",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "phone": "+1-555-123-4567",
  "phoneExt": "123",
  "status": "PENDING",
  "roles": [
    "CUSTOMER_REP",
    "ADMIN"
  ],
  "key": "ERP-USER-12345",
  "datUsername": "johndoe_dat",
  "mcpUsername": "johndoe_mcp",
  "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "teams": [
    { … }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z",
  "deletedAt": null
}

Delete user

Request

Soft delete a user (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/users/550e8400-e29b-41d4-a716-446655440000?by=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

User deleted successfully

Response
No content

Search users

Request

Search users using OpenSearch-powered full-text and field-specific search.

This endpoint provides fast, indexed search across user data with support for:

  • Full-text search across multiple fields
  • Field-specific filtering with various operators
  • Sorting and pagination
  • Saved search preferences

Note: Only active (non-deleted) users are searchable. Soft-deleted records are automatically excluded from all search results.

Response Formats:

  • flat (default): Returns indexed fields only for faster performance
  • full: Returns complete user objects with all relationships
Security
BearerAuth
Bodyapplication/jsonrequired
criteriaobject(UserSearchCriteria)

Search criteria to filter users

paginationobject(SearchPaginationInput)

Pagination options for search requests

sortArray of objects(SearchSortOption)<= 3 items

Sort options for the search results

Example: [{"field":"createdAt","order":"desc"}]
savedSearchobject(SavedSearchLookup)

Optional saved search to load preferences from. When provided, the saved search criteria will be loaded and merged with any explicit criteria.

formatstring

Response format:

  • flat: Returns only indexed fields (default, faster)
  • full: Returns complete user objects
Default "flat"
Enum"flat""full"
curl -i -X POST \
  https://api.mvmnt.io/v1/users/search \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criteria": {
      "id": {
        "operator": "EQUALS",
        "values": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "name": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "email": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "emailVerified": {
        "operator": "TRUE"
      },
      "phone": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "status": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "roles": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "visibility": {
        "operator": "ONE_OF",
        "values": [
          "ACTIVE",
          "PENDING"
        ]
      },
      "teamIds": {
        "operator": "EQUALS",
        "values": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      },
      "teamNames": {
        "operator": "INCLUDES",
        "values": [
          "search term"
        ]
      },
      "customersCount": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "quotesCount": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "quotesWon": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "quoteWinRate": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "ordersCount": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "ordersTotalRevenue": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "ordersTotalTransportationCost": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "ordersTotalGrossProfit": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "averageGrossProfitPerOrder": {
        "operator": "GREATER_THAN",
        "value": 1000.5
      },
      "carriersCount": {
        "operator": "BETWEEN",
        "min": 10,
        "max": 100
      },
      "createdAt": {
        "operator": "AFTER",
        "value": "2025-01-01T00:00:00Z"
      },
      "lastInvitedAt": {
        "operator": "AFTER",
        "value": "2025-01-01T00:00:00Z"
      }
    },
    "pagination": {
      "pageNumber": 1,
      "pageSize": 50
    },
    "sort": [
      {
        "field": "createdAt",
        "order": "desc"
      }
    ],
    "savedSearch": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "format": "flat"
  }'

Responses

Successful search results

Bodyapplication/json
dataArray of objectsrequired

Search results - either flat rows or full user objects based on format parameter

objectstringrequired

Object type identifier for discriminating between flat and full response formats

Value"USER_SEARCH_ROW"
Discriminator
idstring(uuid)required
namestringrequired
emailstring(email)required
emailVerifiedbooleanrequired

Whether email is verified

phonestring or null
statusstringrequired
Enum"pending""active""inactive"
rolesArray of strings

User roles

visibilitystring or null
Enum"ALL""LIMITED"
teamIdsArray of strings(uuid)

Team IDs (maps from groupIds)

teamNamesArray of strings

Team names (maps from groupNames)

customersCountintegerrequired

Number of customers (maps from shippersCount)

quotesCountinteger or null
quotesWoninteger or null
quoteWinRatenumber or null(float)

Win rate percentage

ordersCountintegerrequired

Number of shipments

ordersTotalRevenuenumber(float)required

Total shipment revenue

ordersTotalTransportationCostnumber(float)required

Total transportation cost

ordersTotalGrossProfitnumber(float)required

Total gross profit

averageGrossProfitPerOrdernumber or null(float)

Average gross profit per shipment

carriersCountintegerrequired

Number of carriers

createdAtstring(date-time)required
lastInvitedAtstring or null(date-time)
paginationobject(SearchPaginationInfo)required

Pagination information for search results

pageNumberintegerrequired

Current page number

Example: 1
pageSizeintegerrequired

Number of results returned on this page

Example: 50
totalPagesintegerrequired

Total number of pages available

Example: 25
totalResultsinteger>= 0required

Total number of matching results (excluding soft-deleted records)

Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalPages": 25
  },
  "totalResults": 0
}

Vendors

Vendor management operations

Operations

Vendor Contacts

Vendor contact management operations

Operations

Vendor Payment Methods

Vendor payment method management operations

Operations

Event Notifications

Webhooks