CROPWISE SERVICES
Working with Organizations 🏢
Overview
Organizations represent the entity in the Cropwise Core Services with a set of properties. This entity groups and controls all the resources involved in agriculture, including different farming operations.
Core Concepts
What is an Organization?
An organization in the Cropwise Core Services represents:
- Represents the company, also defined as the business unit
- This entity groups and controls all the resources involved in the culture, for instance, different crops, seasons
- Multiple organizations can exist within a workspace
Organization Structure
Workspace
└── Organization ← You are here
└── Properties
└── Fields
API Endpoints
All organization endpoints are fully documented in our OpenAPI specification. For detailed information about request/response formats, authentication requirements, and interactive examples, please visit:
View Interactive Organizations API Documentation →
Available Endpoints
- POST
/v2/orgs- Create a new organization - GET
/v2/orgs/{id}- Retrieve organization details - PUT
/v2/orgs/{id}- Update an existing organization - DELETE
/v2/orgs/{id}- Delete an organization - GET
/v2/orgs/{org_id}/properties- List properties for an organization
Best Practices
Naming Conventions
- Use descriptive, unique names for organizations
- Avoid special characters except hyphens and spaces
- Keep names under 100 characters
Data Management
- Always include contact information for support purposes
- Set appropriate timezone for accurate data handling
- Use consistent address formats within your region
Performance Tips
- Use pagination for large organization lists
- Cache organization data when possible
- Use search filters to reduce API calls
Error Handling
Specific Error Codes
In addition to the standard error codes, the API returns the following specific codes for organization operations:
| Code | Message | When Triggered |
|---|---|---|
| EORG001 | Invalid currency | currency is invalid |
| EORG002 | Invalid System of units | system_of_units is invalid |
| EORG003 | Invalid Picture URI | picture_uri is not a valid URI |
| EORG004 | Picture must be image/jpeg or image/png format | picture_uri does not point to a JPEG/PNG image |
| EORG005 | Invalid org email | email is invalid |
| EORG006 | Invalid org phone | phone is invalid |
| EORG007 | Invalid org Zip Code | zip_code is invalid |
| EORG008 | Invalid org Country, inform a country code valid. | country_code is invalid |
| EORG009 | Invalid org State | state is invalid |
| EORG010 | Invalid org City | city is invalid |
| EORG011 | Organization does not exist | Organization not found |
| EORG012 | Managed users cannot create organization | Managed user attempted to create an organization |
| EORG013 | User doesn't have permission to perform the requested action | Permission denied |
| EORG015 | Reference Point Geometry Should be of type Point | reference_point is not of type Point |
| EORG016 | New company must not have an ID | Attempt to create with an existing ID |
| EORG017 | Invalid Workspace id | workspace_id is invalid |
| EORG018 | Invalid business line value. It should be one of the following: ... | business_line value is invalid |
| EORG020 | An Organization can not be created without a Workspace ID | Missing workspace_id |
| EORG023 | Organization already exists | Duplicate organization |
| EORG025 | The country code is required for organization creation | Missing country_code |
| EORG026 | Workspace not found | Workspace does not exist |
Error Responses
All error responses follow a standard format defined in the OpenAPI specification. For detailed information about error response formats, status codes, and examples, please refer to:
View Error Response Documentation →
Next Steps
After creating your organization, you can: