API Reference

Kopse API

Resources & Endpoints

Create account

Create a new account.

POST
https://kopse.k.io/api/v1/accounts

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

properties Required

AccountProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

record_invalid

422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    account: Account {
        id: Integer
        name: String
        reference: String
        has_active_services: Boolean
        source: Account source
        email_addresses: [ String ]
        created_at: Unix Timestamp
        trees_awarded: Integer
        last_tree_awarded_at: Unix Timestamp?
    }
}