Skip to content
Aller au contenu
Charitips

API reference · Accounts

Get entitlements

GET/v1/accounts/{accountId}/entitlements

Retrieve the features and limits of an account plan, e.g. to know whether a child account can use custom domains or B2C donations.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • accountId#stringin pathrequired

Response

200 · PublicEntitlements

No field is described in the spec.

  • apiAccess#booleanalways returned

  • widget#booleanalways returned

  • donorPlatform#booleanalways returned

  • activeExperiences#number

  • donors#number

  • userSeats#number

  • editorSeats#number

  • payrollManagerSeats#number

  • monthlyCharitiesSelection#booleanalways returned

  • handPickedCharitiesSelection#booleanalways returned

  • additionalCharities#number

  • minCharitiesInSelection#numberalways returned

  • impactSharing#booleanalways returned

  • impactMonitoring#ImpactMonitoringLevelalways returned

    CAMPAIGN_ENDLIVELIVE_WITH_ACCOUNT_SEGMENTATION

  • analyticsIntegration#booleanalways returned

  • slackIntegration#booleanalways returned

  • teamsIntegration#booleanalways returned

  • customDomain#booleanalways returned

  • sso#booleanalways returned

  • bankTransferPayment#booleanalways returned

  • accountHierarchy#booleanalways returned

  • platform#booleanalways returned

  • delegatedBilling#booleanalways returned

  • agency#booleanalways returned

  • b2c#booleanalways returned

  • fiscalReceiptClaimOnExpiration#booleanalways returned

  • dashboardAccess#booleanalways returned

  • accountId#stringalways returned

Errors

  • 401Unauthorized

    Missing, expired or invalid access token.

    {
  "statusCode": 401,
  "message": "Unauthorized"
}
  • 403Account closed
    {
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}
GET /v1/accounts/<accountId>/entitlements
curl -X GET https://api.sandbox.charitips.com/v1/accounts/<accountId>/entitlements \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.