v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Vendor Contacts

Filter vendor contacts

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

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

post/vendor-contacts/filter

Request body

pageSizeinteger

Number of results per page

cursorstring

Pagination cursor for next page

Example request

{
  "filter": {
    "and": [
      {
        "roles": {
          "includes": "BILLING"
        }
      },
      {
        "vendorId": {
          "equalTo": "550e8400-e29b-41d4-a716-446655440001"
        }
      }
    ]
  },
  "pageSize": 50
}

Response

Filtered vendor contacts with pagination

Example response

{
  "data": [
    {
      "object": "VENDOR_CONTACT",
      "vendor": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345"
      },
      "email": "john.smith@abcwarehouse.com",
      "phone": "+1-555-123-4567",
      "role": "Billing Manager",
      "roles": [
        "BILLING",
        "AGENT"
      ],
      "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"
    }
  ],
  "pageInfo": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}