Carrier Contacts

Filter carrier contacts

Changed on

Query carrier contacts using flexible filter criteria with AND/OR logic.

By default, only non-deleted carrier contacts are returned (deletedAt: { isNull: true }). Override this by explicitly setting deletedAt filter criteria.

post/carrier-contacts/filter

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/carrier-contacts/filter
  • Auth: HTTP bearer

Request body

pageSizeinteger

Number of results per page

cursorstring

Pagination cursor for next page

Example request

{
  "filter": {
    "and": [
      {
        "contactTypes": {
          "includes": "DISPATCH"
        }
      },
      {
        "email": {
          "isNull": false
        }
      }
    ]
  },
  "pageSize": 50
}

Response

Filtered carrier contacts with pagination

Example response

{
  "data": [
    {
      "object": "CARRIER_CONTACT",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "carrier": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-CARRIER-SWIFT",
        "name": "Swift Transportation",
        "phoneNumber": "+1-555-987-6543",
        "email": "dispatch@swifttrans.com",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "name": "Jane Dispatcher",
      "contactInfo": {
        "name": "John Smith",
        "email": "john.smith@example.com",
        "phoneNumber": "+1-555-0100",
        "title": "Operations Manager"
      },
      "contactTypes": [
        "DISPATCH",
        "AFTER_HOURS"
      ],
      "invitedUser": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "deletedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "key": "ERP-CARRIER-CONTACT-001",
      "createdAt": "2025-01-15T10:00:00Z"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  },
  "errors": [
    {
      "field": "/required",
      "message": "missing property 'status'"
    }
  ]
}

Changes

  • 2cd6ecfbeb82Revision changes
    • 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

    • 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 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

    • info

      added the required property to the response with the status