Skip to main content

Compliance Hub - Consent Current

Endpoint​

/o/consent/current

Overview​

Returns the current consent object for one app user matched by query.

Authentication​

Countly API supports three authentication methods:

  1. API key query parameter: api_key=YOUR_API_KEY
  2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
  3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions​

Requires compliance_hub Read permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
queryJSON String (Object)NoJSON-stringified user lookup filter against app_users{app_id}.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

query Object Structure​

Decoded example:

{
  "did": "device_123"
}

Response​

Success Response​

{
  "sessions": true,
  "events": true,
  "crashes": false
}

No consent found:

{}

Response Fields​

FieldTypeDescription
(root object)ObjectConsent key-value object for matched user.

Error Responses​

  • 400
{
  "result": "Missing parameter \"api_key\" or \"auth_token\""
}
  • 400
{
  "result": "Missing parameter \"app_id\""
}
  • 401
{
  "result": "User does not have right"
}

Behavior/Processing​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Consent foundUser document matched and contains consentReturns matched user's consent object.Raw consent object
No consent/userNo match or no consent fieldReturns empty object.Raw {}

Impact on Other Data​

  • Read-only endpoint.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission checksReads member account and feature access for read validation.
countly.appsApp validation/context loadingValidates app_id and app context for lookup scope.
countly.app_users{appId}Current consent lookupReads one app user document and extracts consent field.

Examples​

/o/consent/current?
  api_key=YOUR_API_KEY&
  app_id=6991c75b024cb89cdc04efd2&
  query={"did":"device_123"}

Last Updated​

2026-02-17