Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Climate Corporation Exports API

General data export endpoints.

The Climate Corporation Exports API is one of 8 APIs that The Climate Corporation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Exports. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 4.0.11.

Requests are made against a single base URL, https://platform.climate.com/.

3 operations 3 paths 7 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.11
Base URL
https://platform.climate.com
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

The Climate Corporation Exports API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2_authorization_code) using the authorizationCode flow, exposing 21 scopes. An API key is passed in the header as X-Api-Key (api_key).

  • oauth2_authorization_code — Log in with FieldView OAuth2 provider (Authorization Code Grant). Used to authorize the client (partner) and user. The accesstoken is required to be provided i…
  • api_key — API access key used to control throttling (429 responses). This key is typically formatted: partner-{name}-{uuid}

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Exports 3

General data export endpoints.

POST
/v4/exports
Initiate a new export request.
postExport body → 201400401403429500503
GET
/v4/exports/{exportId}/status
Retrieve the status of an Export.
fetchExportStatusById 1 param → 200400401403404429500503
GET
/v4/exports/{exportId}/contents
Retrieve the binary contents of a processed export request.
fetchExportContentsById 3 params → 204206304400401403404409

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ExportStatus (5 properties), Export (2 properties), Error (1 property), ExportContents (1 property). Each schema is shown below with its type and property counts.

BinaryData
string
Binary contents
CreatedExport
object
1 property 1 required
ExportContents
object
1 property 1 required
Empty
object
Export
object
Client request to export data from a user.
2 properties 1 required
Error
object
1 property
ExportStatus
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-climate-corporation-exports-api-openapi.yml Raw ↑

Other APIs The Climate Corporation publishes across the network.

The Climate Corporation Boundaries API
The Climate Corporation FarmOrganizations API
The Climate Corporation Fields API
The Climate Corporation Layers API
The Climate Corporation Operations API
The Climate Corporation ResourceOwners API
The Climate Corporation Uploads API