GetWorkerLeadsRequestDto
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.
Поля
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
pagination | Pagination | да | — |
searchQuery | string | нет | 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. |
createFromFilter | string | нет | ISO date. Kept for compatibility — createdAt is the range form. |
createToFilter | string | нет | ISO date. Kept for compatibility — createdAt is the range form. |
firstName | string | нет | Prefix match on the first name. |
lastName | string | нет | Prefix match on the last name. |
createdAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the creation timestamp. |
updatedAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the last-update timestamp. Leads never updated are excluded. |
genders | GenderParam[] | нет | — |
birthDate | PaginationRangeFilter<string> | нет | ISO date (yyyy-MM-dd) range over the birth date. |
nationality | string | нет | Prefix match on the nationality. |
religion | string | нет | Prefix match on the religion. |
employmentTypes | EmploymentTypeParam[] | нет | — |
referralSources | ReferralSourceDto[] | нет | — |
transportTypes | TransportTypeParam[] | нет | Matches leads having any of the listed transport types. |
hasExperience | boolean | нет | — |
hasCertificate | boolean | нет | — |
hasAllergy | boolean | нет | — |
childs | boolean | нет | — |
workWithMen | boolean | нет | — |
workWithWomen | boolean | нет | — |
goToWorkDate | PaginationRangeFilter<string> | нет | ISO date (yyyy-MM-dd) range. |
maxClientsCount | PaginationRangeFilter<number> | нет | — |
paidVacationPerYearCount | PaginationRangeFilter<number> | нет | — |
workerCreated | boolean | нет | Whether a worker has already been created from this lead. |
workerNotCreatedReason | string | нет | Prefix match on the reason the worker was not created. |
linkedWorkerId | number | нет | Worker this lead was converted into. |
city | string | нет | Prefix match on any of the lead addresses. |
postalCode | string | нет | Prefix match on any of the lead addresses. |
street | string | нет | Prefix match on any of the lead addresses. |
regionCodeIds | number[] | нет | — |
utmSource | string | нет | Prefix match on the UTM source. |
utmMedium | string | нет | Prefix match on the UTM medium. |
utmCampaign | string | нет | Prefix match on the UTM campaign. |
utmTerm | string | нет | Prefix match on the UTM term. |
utmContent | string | нет | Prefix match on the UTM content. |
phoneNumber | string | нет | Exact match against the linked phone contacts. Normalized before comparison (digits only, 49-prefixed), so a partial number does not match. |
email | string | нет | Exact match against the linked email contacts. Stored as a value object, so a partial address does not match — pass the full address. |
comment | string | нет | Substring match on the general comment. |
allergyComment | string | нет | 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"
}