Sign in

v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB
Contact

Find contacts by custom field value

Returns an array of contacts having a certain custom field value set.

get/Contact/Factory/findContactsByCustomFieldValue

Query parameters

valuestring required

The value to be checked.

customFieldSetting[id]string

ID of ContactCustomFieldSetting for which the value has to be checked.

customFieldSetting[objectName]string
Example:ContactCustomFieldSetting

Object name. Only needed if you also defined the ID of a ContactCustomFieldSetting.

customFieldNamestring required

The ContactCustomFieldSetting name, if no ContactCustomFieldSetting is provided.

Response

Array of contacts having a certain custom field value set.

Example response

{
  "objects": [
    {
      "id": "0",
      "objectName": "Contact",
      "name": "string",
      "status": "100",
      "customerNumber": "Customer-1337",
      "parent": {
        "id": "0",
        "objectName": "Contact"
      },
      "surename": "John",
      "familyname": "Snow",
      "titel": "Commander",
      "category": {
        "id": "3",
        "objectName": "Category"
      },
      "description": "Rightful king of the seven kingdoms",
      "sevClient": {
        "objectName": "SevClient"
      },
      "name2": "Targaryen",
      "defaultCashbackTime": "string",
      "defaultCashbackPercent": "string",
      "defaultTimeToPay": "string",
      "taxOffice": "string",
      "exemptVat": "false",
      "defaultDiscountAmount": "string",
      "defaultDiscountPercentage": "false",
      "buyerReference": "string",
      "governmentAgency": "false",
      "additionalInformation": "string"
    }
  ]
}