API ReferenceContractor
Retrieve contractors list
Retrieve contractors list
Authorization
apiKey Authorization<token>
Value for the Authorization header parameter.
In: header
Query Parameters
page?integer
The collection page number
Default
1itemsPerPage?integer
The number of items per page
Range
0 <= value <= 100Default
30search?string
customFieldValue[{customFieldDefinitionId}]?string
customFieldValueRange[{customFieldDefinitionId}][gt]?string
customFieldValueRange[{customFieldDefinitionId}][lt]?string
customFieldValueRange[{customFieldDefinitionId}][gte]?string
customFieldValueRange[{customFieldDefinitionId}][lte]?string
excludeIds[]?array<string>
id[]?array<string>
attendants.crmUser?string
attendants.crmUser[]?array<string>
industryBranches?string
industryBranches[]?array<string>
order[name]?string
Default
"asc"Value in
- "asc"
- "desc"
order[createdAt]?string
Default
"asc"Value in
- "asc"
- "desc"
order[updatedAt]?string
Default
"asc"Value in
- "asc"
- "desc"
exists[email]?boolean
Response Body
curl -X GET "https://example.com/crm/contractors"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "fullName": "string", "pictureSm": "string", "pictureLg": "string", "email": "string", "phoneNumber": "string", "defaultLocation": "string", "shortCode": "string", "canManage": false, "vatId": "string", "attendants": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "email": "string", "pictureSm": "string", "pictureLg": "string" } ], "industryBranches": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "customFields": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "valueId": "b772d050-4ba4-443b-8ca7-cc1e42bdd731", "name": "string", "description": "string", "dataType": "text", "valueText": "string", "valueFloat": "string", "valueDateTime": "2019-08-24T14:15:22Z", "valueSelectOptions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "value": "string", "weight": 0, "decorator": "#78909c" } ], "valueSelectUsers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "email": "string", "pictureSm": "string" } ], "valueDepartment": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } } ] }]