Trace Connect APIs
- Introduction
- Authentication using JWT
- OAuth 2.0
- Basic APIs
- Advanced APIs
List Farmers Endpoint
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,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"submission": {
"id": "<string>",
"form_details": {
"id": "<string>",
"products": [
{
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"fields": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"key": "<string>",
"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>",
"owner": "<string>"
},
"values": [
{
"id": "<string>",
"field_details": {
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"field": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"value": "<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>",
"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": "jsmith@example.com",
"identification_no": "<string>",
"reference_number": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}
]
}Authorizations
Query Parameters
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.
Response
The total count of farmers in the response.
An array containing details of farmers returned in the response.
First name of the farmer. This is part of the farmer's personal details.
1 - 100Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.
Information related to the Connect card of the farmer.
1100Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.
11 - 1001 - 100TEXT, INTEGER, FLOAT, RADIO, MULTI_SELECT, EMAIL, PHONE, DATE, BOOLEAN, DROPDOWN 1001001001001001001001 - 100TEXT, INTEGER, FLOAT, RADIO, MULTI_SELECT, EMAIL, PHONE, DATE, BOOLEAN, DROPDOWN 100100100100100100100Name of the product.
1 - 500Unique identifier for the product.
Premiums associated with the product.
Indicates whether the product is currently active.
Date and time when the product information was last updated.
Date and time when the product was created.
Description of the product.
500URL to the image or photo of the product.
Identifier of the user who created the product.
Identifier of the user who last updated the product.
1 - 1001 - 100TRANSACTION, FARMER, PAYMENT, PRODUCT Phone number of the farmer. This is typically used for contacting the farmer if necessary.
Date and time when the farmer information was last updated. This field is automatically generated and cannot be modified directly.
Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.
URL to the photo of the farmer. This could be a link to a profile picture or any relevant image associated with the farmer.
Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.
500Name of the house or building where the farmer resides. This could be useful for address clarification.
100Name of the street where the farmer resides. This is part of the farmer's address details.
500Name of the city where the farmer resides. This is part of the farmer's address details.
500Name of the sub-province where the farmer resides. This is part of the farmer's address details.
500Name of the province where the farmer resides. This is part of the farmer's address details.
500Latitude coordinate of the farmer's location. This is used for geolocation purposes.
Longitude coordinate of the farmer's location. This is used for geolocation purposes.
Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.
50Name of the country where the farmer resides. This is part of the farmer's address details.
500Additional number for reference. It will be a auto generated value field.
10Email address of the farmer. This is used for electronic communication with the farmer.
100Identification number of the farmer. This could be a national identification number or any other form of identification.
100Reference number associated with the farmer. This could be a reference to another system or database.
100Last name of the farmer. This is part of the farmer's personal details.
100Date of birth of the farmer. This is part of the farmer's personal details.
Gender of the farmer. This is part of the farmer's personal details.
50Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.
GRANTED, NOT_GRANTED, UNKNOWN Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.
Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.
Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.
The URI for the next page of results, if available.
The URI for the previous page of results, if available.
curl --request GET \
--url http://localhost:3000/connect/v1/supply-chains/farmers/ \
--header 'Authorization: <api-key>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"entity_card": {
"id": "<string>",
"card": {
"id": "<string>",
"card_id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"display_id": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"is_active": true,
"creator": "<string>",
"updater": "<string>",
"entity": "<string>"
},
"submission": {
"id": "<string>",
"form_details": {
"id": "<string>",
"products": [
{
"id": "<string>",
"premiums": "<string>",
"is_active": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"image": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"fields": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
}
],
"field_config": [
{
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"key": "<string>",
"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>",
"owner": "<string>"
},
"values": [
{
"id": "<string>",
"field_details": {
"id": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"label": "<string>",
"label_en_us": "<string>",
"label_en_uk": "<string>",
"label_fr": "<string>",
"label_nl": "<string>",
"label_ind": "<string>",
"type": "TEXT",
"key": "<string>",
"required": true,
"default_value": "<string>",
"options": "<string>",
"creator": "<string>",
"updater": "<string>"
},
"field": "<string>",
"updated_on": "2023-11-07T05:31:56Z",
"created_on": "2023-11-07T05:31:56Z",
"value": "<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>",
"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": "jsmith@example.com",
"identification_no": "<string>",
"reference_number": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"gender": "<string>",
"consent_status": "GRANTED",
"creator": "<string>",
"updater": "<string>",
"buyer": "<string>"
}
]
}