List charities selections

• limit#numberin queryintegerminimum 1maximum 100

  The max number of items to return.

• cursor#stringin queryUUID

  The id of the last item from the previous page. Used to fetch the next page.

• includeCharities#booleanin query

  Include charities

• accountId#stringin queryUUID

  Id of the account. Only useful for Platform customers to filter donations by child accounts

• type#stringin query

  Type of charities selection. Use GENERIC to get selections curated and kept up to date by Charitips.

  GENERICCUSTOM

• sort#stringin query

  Sorting field and order

  createdAt:asccreatedAt:descname:ascname:desc

No field is described in the spec.

• charitiesSelectionId#stringalways returned

• name#stringalways returned

• type#CharitiesSelectionTypealways returned

  GENERICCUSTOM

• featuredCharitiesIds#string[]always returned

• isFeatured#booleanalways returned

• accountId#string

• authorId#string

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

• charities#OnlyCharityId[]always returned

  1 child field

  • charityIdstringalways returned

Errors

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }