Skip to content

Organization Data

The following data structures are published by the platform. If you want to learn how to retrieve entities published by the platform, please refer section "Accessing Platform Data" in our introduction to the topic.

Entity Organization

 `/api/v1.0/{orgId}/FarmOrgEntities/{moduleId}/{dataAreaEntityId}`
  • orgId represents the organization you want data from; in most cases it's the current organization
  • moduleId represents the ID of the module requesting the data; in most cases it's your module ID
  • dataAreaEntityId represent the ID of the entity you want to access; the user must have given consent ot the data area "Farm Organization Definition" for this call to be successful. (See Data Areas and Entities for details)
const { data: organization, isLoading } = useEntity("FarmOrganization", "farm_organizations");

JSON Format

{
    "parentOrganizationId": null,
    "organizationName": "Tomato farm",
    "legalForm": null,
    "primaryContactId": "327ee08d-d1e1-4d99-9ce3-abcdef123456",
    "secondaryContactId": null,
    "creatorId": "327ee08d-d1e1-4d99-9ce3-abcdef123456",
    "addressId": "ea767d7e-d2d8-4948-89f5-abcdef123456",
    "ownerId": "327ee08d-d1e1-4d99-9ce3-abcdef123456",
    "description": "This is the farm right behind the ridge after crossing road B3",
    "address": {
        "addressLine1": "AV MADERO NTE NO. 1000, SAN JOSE, 59663",
        "addressLine2": "SAN JOSE, 59663",
        "addressLine3": null,
        "directions": "Turn right after the bridge, entry is on your left.",
        "city": "Michoacan",
        "postalCode": "59663",
        "state": "Zamora",
        "countryId": "fd45d528-dfde-420e-9554-8dd02897a084",
        "longitude": 19.1234,
        "latitude": 49.12345,
        "id": "ea767d7e-d2d8-4948-89f5-abcdef123456"
    },
    "id": "606e598c-a6d8-4904-8536-abcdef123456"
}

Properties

Property Type Description
parentOrganizationId String ID of the parent organization; used to create hierarchies between organizations, e.g. cooperatives
organizationName String Official name of the business; also used as display name in HortiView and on invoices, etc.
legalForm UUID Currently unused
primaryContactId UUID ID of the user who serving as the company's contact person
secondaryContactId UUID ID of the user who serving as the company's primary contact person's backup
creatorId UUID ID of the user who created the organization
addressId UUID ID of the address used for this organization
ownerId UUID ID of the user who owns the company
description String Optional description of the organization
address.addressLine1 String Line 1 of the address record
address.addressLine2 String Line 2 of the address record
address.addressLine3 String Line 3 of the address record
address.directions String Can be used to provide detailed instructions of the organization is hard to locate
address.city String The city the organization is located in
address.postalCode String ZIP code of the organization
address.state String State or province the organization operates in
address.countryId UUID ID of the country the organization operates in (see CommonData API for details)
address.longitude Float Location info of the organization
address.latitude Float Location info of the organization
address.id UUID ID of this address record (identical to addressId)
id UUID ID of this organization