Get Organization

GET /orgs/{organization}

Each funding partner in the tree tracker is an Organization, and they have their own unique URL, with a UUID. Sales will provide you your UUID and that will act as your entrypoint. New orders will show up here, and you can check the status of those orders or call their endpoint for more details.

Path parameters

organization string(uuid) Required

Unique identifier given to an organization by Protect Earth support.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id string(uuid) Required
- name string Required
- orders array[object] Required
  
  Hide orders attributes Show orders attributes object
  
  id string(uuid) Required
  
  receivedOn string(date-time) Required
  
  isFulfilled boolean Required
  
  Default value is false.
  
  orderedUnits integer Required
  
  allocatedUnits integer Required
  
  href string(url) Required
404 application/problem+json

Organization not found.
Hide response attributes Show response attributes object
- type string Required
- title string Required
- status integer
- detail string
- instance string

GET /orgs/{organization}

curl \
 --request GET 'https://api.protect.earth/orgs/61f423e5-3cac-4e82-a520-b233730637bb'

Response examples (200)

{
  "id": "61f423e5-3cac-4e82-a520-b233730637bb",
  "name": "Your Amazing Company",
  "orders": [
    {
      "id": "53f7bd7b-2ee2-4be4-a15b-e09c76a150f9",
      "receivedOn": "2021-11-22T16:37:15.000Z",
      "isFulfilled": false,
      "orderedUnits": 1000,
      "allocatedUnits": 700,
      "href": "https://api.protect.earth/orders/53f7bd7b-2ee2-4be4-a15b-e09c76a150f9.json"
    }
  ]
}

Response examples (404)

{
  "type": "https://protect.earth/probs/something-went-wrong",
  "title": "You do not have enough credit.",
  "status": 400,
  "detail": "Your current balance is 30, but that costs 50.",
  "instance": "/account/12345/msgs/abc"
}