Introduction

Introduction to our external API.


Authorization

In order to use this API, you must create a Personal Access Token and then pass an Authorization Header in your requests with the value Bearer {token}.

Create your Personal Access Token in Givecloud

  1. Log into your Givecloud Account
  2. Go to My Profile
  3. Scroll to Personal Access Tokens section
  4. Pick a name: API OAuth client creation
  5. On the next screen, you will get the randomly generated PAT string. Keep it somewhere safe as it is encoded and therefore we will not be able to retrieve it for you.

Compromised or Lost Token?

If you've lost your token or it's been compromised, you will want to revoke that token so that it can no longer be used to access the API.

Revoke Compromised / Lost Token

  1. Log into your Givecloud Account
  2. Go to My Profile
  3. Scroll to Personal Access Tokens section
  4. Click Revoke next to the token you'd like to remove

Filtering results

To filter the lists of data in this API, you can use the filter query param along with the name of the parameter you'd like to filter.

As an example, if you'd like to filter the Contributions List based on the ordered_after filter which requires a date, you would do use the following syntax:

GET /admin/api/v2/contributions?filter[ordered_after]=2021-01-21