curl --request GET \
--url http://localhost:3000/connect/v1/supply-chains/farmers/ \
--header 'Authorization: <api-key>'{
"count": 123,
"results": [
{
"first_name": "<string>",
"id": "<string>",
"entity_card": {
"card": {
"card_id": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"entity": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>"
},
"submission": {
"values": [
{
"field": "<string>",
"value": "<string>",
"id": "<string>",
"field_details": {
"label": "<string>",
"type": "TEXT",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>"
}
],
"form": "<string>",
"id": "<string>",
"form_details": {
"fields": [
{
"label": "<string>",
"type": "TEXT",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"products": [
{
"name": "<string>",
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>",
"product": "<string>"
},
"phone": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"image": "<string>",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"number": "<string>",
"email": "[email protected]",
"identification_no": "<string>",
"reference_number": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}
],
"next": "<string>",
"previous": "<string>"
}This API endpoint allows you to retrieve a list of farmers within the supply chain system. By sending a GET request to the specified endpoint, you can obtain information about multiple farmer submissions. The API supports secure authentication through an API key included in the request header.
curl --request GET \
--url http://localhost:3000/connect/v1/supply-chains/farmers/ \
--header 'Authorization: <api-key>'{
"count": 123,
"results": [
{
"first_name": "<string>",
"id": "<string>",
"entity_card": {
"card": {
"card_id": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"entity": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>"
},
"submission": {
"values": [
{
"field": "<string>",
"value": "<string>",
"id": "<string>",
"field_details": {
"label": "<string>",
"type": "TEXT",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>"
}
],
"form": "<string>",
"id": "<string>",
"form_details": {
"fields": [
{
"label": "<string>",
"type": "TEXT",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"owner": "<string>",
"id": "<string>",
"products": [
{
"name": "<string>",
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"label": "<string>",
"key": "<string>",
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"visibility": true,
"required": true,
"creator": "<string>",
"updater": "<string>"
}
],
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"form_type": "TRANSACTION",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"creator": "<string>",
"updater": "<string>",
"product": "<string>"
},
"phone": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"image": "<string>",
"description": "<string>",
"house_name": "<string>",
"street": "<string>",
"city": "<string>",
"sub_province": "<string>",
"province": "<string>",
"latitude": 123,
"longitude": 123,
"zipcode": "<string>",
"country": "<string>",
"number": "<string>",
"email": "[email protected]",
"identification_no": "<string>",
"reference_number": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}
],
"next": "<string>",
"previous": "<string>"
}Filter by first name.
Filter by last name.
Filter by number.
Filter by updated timestamp after a specified time.
Filter by created timestamp after a specified time.
Number of results to return per page.
The initial index from which to return the results.
The total count of farmers in the response.
An array containing details of farmers returned in the response.
Show child attributes
The URI for the next page of results, if available.
The URI for the previous page of results, if available.