Organizations

Organizations Documentation

Organization [LIST]

Organization [LIST]

Request

Endpoint

GET /api/v2/organizations
Content-Type: application/vnd.api+json

Body

Parameters

Sorts

name

Type Unknown

Description Sort organizations by name

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "6fcf9f2f-25c6-4a7c-9d76-db7bfc3b0041",
      "type": "organizations",
      "attributes": {
        "abbreviation": null,
        "code": null,
        "country": null,
        "created_at": "2021-11-23T14:38:10Z",
        "default_currency_code": "USD",
        "gift_aid_percentage": null,
        "logo": null,
        "name": "Organization446",
        "oauth": false,
        "updated_at": "2021-11-23T14:38:10Z",
        "updated_in_db_at": "2021-11-23T14:38:10Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Organization]

Description An array of Organizations

Organization [GET]

Organization [GET]

Request

Endpoint

GET /api/v2/organizations/f543998b-5dbf-4e4b-ab2b-00f2751986b8
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "f543998b-5dbf-4e4b-ab2b-00f2751986b8",
    "type": "organizations",
    "attributes": {
      "abbreviation": null,
      "code": null,
      "country": null,
      "created_at": "2021-11-23T14:38:10Z",
      "default_currency_code": "USD",
      "gift_aid_percentage": null,
      "logo": null,
      "name": "Organization442",
      "oauth": false,
      "updated_at": "2021-11-23T14:38:10Z",
      "updated_in_db_at": "2021-11-23T14:38:10Z"
    }
  }
}

Fields

Attributes

abbreviation

Type string

Description The abbreviated form of the organization name

code

Type string

Description The short code of the organization

country

Type string

Description The primary country of the organization

created_at

Type date

Description The timestamp of when this resource was created

default_currency_code

Type string

Description The default currency code of the organization

gift_aid_percentage

Type number

Description The percentage added to each donation from a gift aid program

logo

Type string

Description The URL pointing to the logo image file of the organization

name

Type string

Description The name of the organization

oauth

Type boolean

Description If the organization requires users to authenticate via OAuth to connect

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.