Get organisation
This page explains how to retrieve the details of an existing organisation. For the full response schema, see the Get organisation endpoint in the API reference.
How it works
Send a GET request to /v3/organisations/{id} with the organisation's unique ID. The API returns the full organisation record, including fields that ekko populates automatically such as proportionalProfitShare, serviceFeePercentage, inherited impact providers and available calculation types.
When to use this endpoint
This endpoint is useful when you need to:
- Verify an organisation's current configuration after creation or update
- Check which impact providers are available for an organisation
- Confirm the calculated
proportionalProfitShareacross the hierarchy - Look up the
statusof an organisation, including any impact provider exclusion messages - Retrieve the
organisationReferencefor reconciliation
Example response
{
"organisationId": "2f6d6b1f-1c6a-4e9a-9c15-7b8a0db1a2c3",
"parentOrganisationId": "9e1d3a52-0e3d-4a9f-8b6e-1c2d3e4f5a6b",
"organisationReference": "MID1234567",
"tradingName": "Blossom & Bloom",
"legalName": "BB Flowers Ltd",
"address": {
"line1": "Ground floor",
"line2": "45 Rosewood Avenue",
"line3": "Unit 124A",
"city": "London",
"postalCode": "SW1A 1AA",
"state": "",
"countryCode": "GBR"
},
"currencyCode": "GBP",
"website": "https://www.blossombloom.co.uk",
"billing": {
"companyRegistrationNumber": "987654321",
"currencyCode": "GBP",
"email": "[email protected]",
"taxNumber": "123456789"
},
"mcc": "5992",
"relativeProfitShare": 0.6,
"proportionalProfitShare": 0.12,
"serviceFeePercentage": 0.2,
"status": {
"value": "active",
"message": null
},
"impactPartners": [
{
"id": "250636c2-8702-47c1-9720-7c3f93395790",
"name": "Gold Standard"
},
{
"id": "9405545f-a850-4427-ab0d-10b5b734e925",
"name": "Tusk"
}
],
"calculationTypes": [
"carbon"
]
}The response is identical in structure to the Create organisation response. For a full description of each field, see the response table on that page.
