List charities

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

• includeProfile#booleanin query

  Include charity public profile information as displayed in the widgets.

• locale#stringin query

  Can only be used with includeProfile=true. Locale to be used for text contents available in the charity public profile such as description, tagline and insights

  fren

• slug#stringin query

  Find a charity by its slug. This is useful when you want to find a charity by its slug instead of its charityId.

No field is described in the spec.

• charityId#stringalways returned

• code#numberalways returned

• name#stringalways returned

• causes#Cause[]always returned

• slug#string

• shortSlug#string

• sustainableDevelopmentGoals#SustainableDevelopmentGoal[]always returned

• labels#CharityLabel[]always returned

• creationYear#number

• annualBudget#integer (int64)

• numberOfBeneficiaries#integer (int64)

• fiscalType#CharityFiscalTypealways returned

  PUBLIC_INTERESTHELP_TO_PEOPLE_IN_NEEDHELP_FOR_RELOCATION_OF_DOMESTIC_VIOLENCE_VICTIMS

• type#CharityType

  CHARITYENDOWMENT_FUNDPUBLIC_INSTITUTIONSCIENTIFIC_COOPERATION_FOUNDATIONPRIVATE_HEALTHCARE_ESTABLISHMENT_OF_COLLECTIVE_INTEREST

• fiscalReceiptsSupport#CharityFiscalReceiptsSupportalways returned

  ENABLEDDISABLEDNOT_APPLICABLE

• profile#CharityProfileWithInsightsalways returned

  26 child fields

  • charityProfileIdstringalways returned

  • statusCharityProfileStatusalways returned

    DRAFTPUBLISHED

  • typeCharityProfileTypealways returned

    COUNTRYINTERNATIONAL

  • countrystring

  • languageLanguagealways returned

    fren

  • isAutomaticallyTranslatedbooleanalways returned

  • namestringalways returned

  • taglinestringalways returned

  • purposestringalways returned

  • descriptionstringalways returned

  • websitestring

  • facebookstring

  • twitterstring

  • instagramstring

  • youtubestring

  • linkedInstring

  • linkedInHandlestring

  • annualReportstring

  • logoUrlstring

  • coversstring[]always returned

  • videoUrlstring

  • charityIdstringalways returned

  • createdAtstring (date-time)always returned

  • updatedAtstring (date-time)always returned

  • insightsCharityInsight[]always returned

    6 child fields

    • charityInsightIdstringalways returned

    • valuestringalways returned

    • labelstringalways returned

    • charityProfileIdstringalways returned

    • createdAtstring (date-time)always returned

    • updatedAtstring (date-time)always returned

  • impactIndicatorsCharityImpactIndicator[]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"
  }