Filter location contacts

Changed on Oct 8, 2026

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

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

post/location-contacts/filter

Request

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

Request body

pageSizeinteger

Number of results per page

cursorstring

Pagination cursor for next page

Example request

{
  "filter": {
    "and": [
      {
        "locationId": {
          "equalTo": "770e8400-e29b-41d4-a716-446655440000"
        }
      },
      {
        "isPrimary": {
          "equalTo": true
        }
      }
    ]
  },
  "pageSize": 50
}

Response

Filtered location contacts with pagination

Example response

{
  "data": [
    {
      "object": "LOCATION_CONTACT",
      "id": "880e8400-e29b-41d4-a716-446655440000",
      "locationId": "770e8400-e29b-41d4-a716-446655440000",
      "location": {
        "object": "LOCATION",
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "customerId": "550e8400-e29b-41d4-a716-446655440000",
        "customer": {
          "object": "CUSTOMER",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Acme Manufacturing Corp",
          "friendlyId": "A123456",
          "website": "https://acme-manufacturing.com",
          "phoneNumber": "+1-555-123-4567",
          "naics": "336411",
          "ein": "12-3456789",
          "duns": "123456789",
          "leadSource": "Referral",
          "dbaName": "Acme Corp DBA",
          "externalId": "EXT-12345",
          "creditLimit": 50000,
          "creditUsageWarning": 40000,
          "freeCreditReq": 5000,
          "defaultMargin": 0.15,
          "minMargin": 0.1,
          "maxMargin": 0.25,
          "defaultInternalNotes": "Contact via email only",
          "defaultCarrierNotes": "Call pickup contact before arrival",
          "defaultExternalNotes": "Please call 1 hour before delivery",
          "group": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345"
          },
          "paymentTerm": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-PAYTERM-NET30",
            "name": "Net 30",
            "description": "Payment due 30 days from invoice date",
            "days": 30,
            "quickPayFee": 5,
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          },
          "notes": "Prefers email communication",
          "closedBy": {
            "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"
          },
          "corporateAddress": {
            "line1": "123 Main St",
            "line2": "Suite 400",
            "city": "Chicago",
            "state": "IL",
            "zipCode": "60601",
            "country": "USA",
            "market": "CHI",
            "latitude": "41.8781",
            "longitude": "-87.6298",
            "isSmartyValidated": true,
            "obeysDst": true
          },
          "billingAddress": {
            "line1": "123 Main St",
            "line2": "Suite 400",
            "city": "Chicago",
            "state": "IL",
            "zipCode": "60601",
            "country": "USA",
            "market": "CHI",
            "latitude": "41.8781",
            "longitude": "-87.6298",
            "isSmartyValidated": true,
            "obeysDst": true
          },
          "key": "ERP-CUSTOMER-12345",
          "contacts": [
            {
              "object": "CUSTOMER_CONTACT",
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "key": "ERP-CONTACT-JOHN-001",
              "name": "John Smith",
              "contactInfo": {
                "name": "John Smith",
                "email": "john.smith@example.com",
                "phoneNumber": "+1-555-0100",
                "title": "Operations Manager"
              },
              "phoneExtension": "1234",
              "isPrimary": true,
              "contactTypes": [
                "BILLING",
                "ACCOUNT_MANAGER"
              ],
              "notifications": [
                "SHIPMENT_PICKED_UP",
                "SHIPMENT_DELIVERED"
              ],
              "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"
              },
              "createdAt": "2025-01-15T10:00:00Z"
            }
          ],
          "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"
          }
        },
        "address": {
          "line1": "123 Main St",
          "line2": "Suite 400",
          "city": "Chicago",
          "state": "IL",
          "zipCode": "60601",
          "country": "USA",
          "market": "CHI",
          "latitude": "41.8781",
          "longitude": "-87.6298",
          "isSmartyValidated": true,
          "obeysDst": true
        },
        "name": "ABC Warehouse - Dallas",
        "key": "ERP-LOC-DALLAS-01",
        "isAppointmentRequired": true,
        "notes": "Call 24 hours ahead for appointment",
        "internalNotes": "Use dock door 5 for expedited shipments",
        "contacts": [
          {
            "object": "LOCATION_CONTACT",
            "id": "880e8400-e29b-41d4-a716-446655440000",
            "name": "Jane Smith",
            "contactInfo": {
              "name": "John Smith",
              "email": "john.smith@example.com",
              "phoneNumber": "+1-555-0100",
              "title": "Operations Manager"
            },
            "phoneExtension": "204",
            "isPrimary": true,
            "contactTypes": [
              "LOCATION_MANAGER",
              "SHIPPING"
            ],
            "key": "ERP-LOC-CONTACT-001",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          }
        ],
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "name": "Jane Smith",
      "contactInfo": {
        "name": "John Smith",
        "email": "john.smith@example.com",
        "phoneNumber": "+1-555-0100",
        "title": "Operations Manager"
      },
      "phoneExtension": "204",
      "isPrimary": true,
      "contactTypes": [
        "LOCATION_MANAGER",
        "SHIPPING"
      ],
      "key": "ERP-LOC-CONTACT-001",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  },
  "errors": [
    {
      "field": "/required",
      "message": "missing property 'status'"
    }
  ]
}

Changes

Oct 8, 2026d727909df9fd Revision changes
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property ///// from the response with the status
- warning
  removed the request property /
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property ///// from the response with the status
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- 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
Oct 7, 20262cd6ecfbeb82 Revision 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
- warning
  removed the optional 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

Operation history (5 revisions)