List Farmers Endpoint - Trace Knowledge Center

Authorizations

Authorization

string

header

required

Query Parameters

first_name

string

Filter by first name.

last_name

string

Filter by last name.

number

string

Filter by number.

updated_after

number

Filter by updated timestamp after a specified time.

created_after

number

Filter by created timestamp after a specified time.

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Response

200 - application/json

count

integer

required

The total count of farmers in the response.

results

object[]

required

An array containing details of farmers returned in the response.

results.first_name

string

required

First name of the farmer. This is part of the farmer's personal details.

Required string length: 1 - 100

results.buyer

string

Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.

results.city

string | null

Name of the city where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.

Available options:

GRANTED,

NOT_GRANTED,

UNKNOWN

results.country

string | null

Name of the country where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

results.created_on

string

Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.

results.creator

string

Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.

results.date_of_birth

string | null

Date of birth of the farmer. This is part of the farmer's personal details.

results.description

string | null

Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.

Maximum length: 500

results.email

string | null

Email address of the farmer. This is used for electronic communication with the farmer.

Maximum length: 100

results.entity_card

object

Information related to the Connect card of the farmer.

results.gender

string | null

Gender of the farmer. This is part of the farmer's personal details.

Maximum length: 50

results.house_name

string | null

Name of the house or building where the farmer resides. This could be useful for address clarification.

Maximum length: 100

results.id

string

Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.

results.identification_no

string | null

Identification number of the farmer. This could be a national identification number or any other form of identification.

Maximum length: 100

results.image

string | null

URL to the photo of the farmer. This could be a link to a profile picture or any relevant image associated with the farmer.

results.last_name

string | null

Last name of the farmer. This is part of the farmer's personal details.

Maximum length: 100

results.latitude

number

Latitude coordinate of the farmer's location. This is used for geolocation purposes.

results.longitude

number

Longitude coordinate of the farmer's location. This is used for geolocation purposes.

results.number

string | null

Additional number for reference. It will be a auto generated value field.

Maximum length: 10

results.phone

string | null

Phone number of the farmer. This is typically used for contacting the farmer if necessary.

results.province

string | null

Name of the province where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

results.reference_number

string | null

Reference number associated with the farmer. This could be a reference to another system or database.

Maximum length: 100

results.street

string | null

Name of the street where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

results.sub_province

string | null

Name of the sub-province where the farmer resides. This is part of the farmer's address details.

Maximum length: 500

results.submission

object

Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.

results.submission.form

string

required

results.submission.values

object[]

required

results.submission.created_on

string

results.submission.creator

string

results.submission.form_details

object

results.submission.form_details.fields

object[]

required

results.submission.form_details.owner

string

required

results.submission.form_details.created_on

string

results.submission.form_details.creator

string

results.submission.form_details.field_config

object[]

results.submission.form_details.form_type

enum<string>

Available options:

TRANSACTION,

FARMER,

PAYMENT,

PRODUCT

results.submission.form_details.id

string

results.submission.form_details.products

object[]

results.submission.form_details.updated_on

string

results.submission.form_details.updater

string

results.submission.id

string

results.submission.product

string

results.submission.updated_on

string

results.submission.updater

string

results.updated_on

string

Date and time when the farmer information was last updated. This field is automatically generated and cannot be modified directly.

results.updater

string

Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.

results.zipcode

string | null

Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.

Maximum length: 50

string | null

The URI for the next page of results, if available.

string | null

The URI for the previous page of results, if available.

Trace Connect APIs

Authorizations

Query Parameters

Response