Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Donately Accounts API
description: The Donately API is a REST/JSON API for online donation and fundraising management.
version: '2019-03-15'
contact:
name: Donately
url: https://developer.donately.com/
servers:
- url: https://api.donately.com/v2
description: Donately API (version 2019-03-15)
security:
- basicAuth: []
tags:
- name: Accounts
description: The organizations a token has access to.
paths:
/accounts:
get:
operationId: listAccounts
tags:
- Accounts
summary: List accounts
description: Lists the accounts (organizations) the authenticated token can access. MODELED - verify against the live reference.
responses:
'200':
description: A list of accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/ListResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/accounts/{id}:
get:
operationId: getAccount
tags:
- Accounts
summary: Retrieve an account
description: Retrieves a single account by ID. MODELED - verify against the live reference.
parameters:
- $ref: '#/components/parameters/IdParam'
responses:
'200':
description: An account object.
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
IdParam:
name: id
in: path
required: true
description: The unique identifier of the resource.
schema:
type: string
schemas:
Error:
type: object
properties:
object:
type: string
example: error
error:
type: object
properties:
type:
type: string
message:
type: string
ListResponse:
type: object
description: Standard Donately list envelope.
properties:
object:
type: string
data:
type: array
items:
type: object
summary:
type: object
params:
type: object
responses:
NotFound:
description: The requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Authentication failed or was not provided.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Auth. Use your Donately API token as the username with an empty password (the token is base64-encoded with a trailing colon). Find the token in the Donately dashboard under Settings -> API.