🔐Authentication

API access is available upon request. To receive an API token to use for our API, please contact your account manager.

Bearer Authorization

The GreenPlaces API uses a bearer token to authenticate requests. API tokens can be scoped to individual permissions.

The bearer token is associated wtih a single company. There are no endpoints that accept for a company ID to be passed in the request body.

All API requests are made over HTTPS. Any calls made to an HTTP endpoint will be forwarded to the corresponding HTTPS endpoint.

Below is an example of using the bearer token in the request, where ACCESS_TOKEN is the bearer token that you received from GreenPlaces:

curl https://app.greenplaces.com/api/me -H ACCESS_TOKEN

Note, the above endpoint is an intraspective endpoint and will return the entity that the bearer token has authenticated to. Below is an example response:

{
    "data": {
        "id": "99d70895-c401-454f-830c-8e0d673ae9c7",
        "name": "Conekin & Hardison",
        "description": null,
        "website": null,
        "slug": "conekin-hardison",
        "created_at": "2023-08-08T09:53:30.000000Z",
        "updated_at": "2023-08-08T09:53:30.000000Z"
    }
}