Skip to content

GetWorkerLeadsRequestDto

← Lead / Worker DTO

Filters for GET Api/WorkerLeads. Every field except pagination is optional — an absent field means the condition is not applied. Passing several narrows by all of them.

Address filters (city, postalCode, street, regionCodeIds) match if ANY of the lead's addresses matches.

Поля

ПолеТипОбязательноеОписание
paginationPaginationда
searchQuerystringнетFull-text search over first and last name together. Independent of the per-field filters below; word-based, so it does not match a partial word.
createFromFilterstringнетISO date. Kept for compatibility — createdAt is the range form.
createToFilterstringнетISO date. Kept for compatibility — createdAt is the range form.
firstNamestringнетPrefix match on the first name.
lastNamestringнетPrefix match on the last name.
createdAtPaginationRangeFilter<string>нетISO 8601 range over the creation timestamp.
updatedAtPaginationRangeFilter<string>нетISO 8601 range over the last-update timestamp. Leads never updated are excluded.
gendersGenderParam[]нет
birthDatePaginationRangeFilter<string>нетISO date (yyyy-MM-dd) range over the birth date.
nationalitystringнетPrefix match on the nationality.
religionstringнетPrefix match on the religion.
employmentTypesEmploymentTypeParam[]нет
referralSourcesReferralSourceDto[]нет
transportTypesTransportTypeParam[]нетMatches leads having any of the listed transport types.
hasExperiencebooleanнет
hasCertificatebooleanнет
hasAllergybooleanнет
childsbooleanнет
workWithMenbooleanнет
workWithWomenbooleanнет
goToWorkDatePaginationRangeFilter<string>нетISO date (yyyy-MM-dd) range.
maxClientsCountPaginationRangeFilter<number>нет
paidVacationPerYearCountPaginationRangeFilter<number>нет
workerCreatedbooleanнетWhether a worker has already been created from this lead.
workerNotCreatedReasonstringнетPrefix match on the reason the worker was not created.
linkedWorkerIdnumberнетWorker this lead was converted into.
citystringнетPrefix match on any of the lead addresses.
postalCodestringнетPrefix match on any of the lead addresses.
streetstringнетPrefix match on any of the lead addresses.
regionCodeIdsnumber[]нет
utmSourcestringнетPrefix match on the UTM source.
utmMediumstringнетPrefix match on the UTM medium.
utmCampaignstringнетPrefix match on the UTM campaign.
utmTermstringнетPrefix match on the UTM term.
utmContentstringнетPrefix match on the UTM content.
phoneNumberstringнетExact match against the linked phone contacts. Normalized before comparison (digits only, 49-prefixed), so a partial number does not match.
emailstringнетExact match against the linked email contacts. Stored as a value object, so a partial address does not match — pass the full address.
commentstringнетSubstring match on the general comment.
allergyCommentstringнетSubstring match on the allergy comment.

Пример

json
{
  "pagination": "<Pagination>",
  "searchQuery": "string",
  "createFromFilter": "string",
  "createToFilter": "string",
  "firstName": "string",
  "lastName": "string",
  "createdAt": "<PaginationRangeFilter<string>>",
  "updatedAt": "<PaginationRangeFilter<string>>",
  "genders": [],
  "birthDate": "<PaginationRangeFilter<string>>",
  "nationality": "string",
  "religion": "string",
  "employmentTypes": [],
  "referralSources": [],
  "transportTypes": [],
  "hasExperience": false,
  "hasCertificate": false,
  "hasAllergy": false,
  "childs": false,
  "workWithMen": false,
  "workWithWomen": false,
  "goToWorkDate": "<PaginationRangeFilter<string>>",
  "maxClientsCount": "<PaginationRangeFilter<number>>",
  "paidVacationPerYearCount": "<PaginationRangeFilter<number>>",
  "workerCreated": false,
  "workerNotCreatedReason": "string",
  "linkedWorkerId": 0,
  "city": "string",
  "postalCode": "string",
  "street": "string",
  "regionCodeIds": [],
  "utmSource": "string",
  "utmMedium": "string",
  "utmCampaign": "string",
  "utmTerm": "string",
  "utmContent": "string",
  "phoneNumber": "+49123456789",
  "email": "user@example.com",
  "comment": "string",
  "allergyComment": "string"
}