List charity profiles

• 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.

• type#stringin query

  Filter for a given type.

  COUNTRYINTERNATIONAL

• language#stringin query

  Filter for a given language

  fren

• country#stringin query

  Filter for a given country. ISO 3166-1 alpha-2 code

No field is described in the spec.

• charityProfileId#stringalways returned

• status#CharityProfileStatusalways returned

  DRAFTPUBLISHED

• type#CharityProfileTypealways returned

  COUNTRYINTERNATIONAL

• country#string

• language#Languagealways returned

  fren

• isAutomaticallyTranslated#booleanalways returned

• name#stringalways returned

• tagline#stringalways returned

• purpose#stringalways returned

• description#stringalways returned

• website#string

• facebook#string

• twitter#string

• instagram#string

• youtube#string

• linkedIn#string

• linkedInHandle#string

• annualReport#string

• logoUrl#string

• covers#string[]always returned

• videoUrl#string

• charityId#stringalways returned

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

• insights#CharityInsight[]always returned

  6 child fields

  • charityInsightIdstringalways returned

  • valuestringalways returned

  • labelstringalways returned

  • charityProfileIdstringalways returned

  • createdAtstring (date-time)always returned

  • updatedAtstring (date-time)always returned

• impactIndicators#CharityImpactIndicator[]always returned

  7 child fields

  • charityImpactIndicatorIdstringalways returned

  • baseAmountinteger (int64)always returned

  • singularLabelstringalways returned

  • pluralLabelstringalways returned

  • charityProfileIdstring

  • createdAtstring (date-time)always returned

  • updatedAtstring (date-time)always 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"
  }