API ReferenceContractor
Retrieve contractors list
GET
Retrieve contractors list
apiKeyheader
Authorization<token>Value for the Authorization header parameter.
page?integerThe collection page number
Default
1itemsPerPage?integerThe number of items per page
Range
0 <= value <= 100Default
30search?stringcustomFieldValue[{customFieldDefinitionId}]?stringcustomFieldValueRange[{customFieldDefinitionId}][gt]?stringcustomFieldValueRange[{customFieldDefinitionId}][lt]?stringcustomFieldValueRange[{customFieldDefinitionId}][gte]?stringcustomFieldValueRange[{customFieldDefinitionId}][lte]?stringexcludeIds[]?array<string>id[]?array<string>attendants.crmUser?stringattendants.crmUser[]?array<string>industryBranches?stringindustryBranches[]?array<string>order[name]?stringDefault
"asc"Value in
"asc""desc"order[createdAt]?stringDefault
"asc"Value in
"asc""desc"order[updatedAt]?stringDefault
"asc"Value in
"asc""desc"exists[email]?booleanContractor collection
- response
[index: integer]?curl -X GET 'https://app.icproject.com/api/instance/demo/crm/contractors'Example Response
[ { "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" } } ] }]