Skip to content
Authrim

Get a consent statement.

GET
/api/admin/consent-statements/{id}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/consent-statements/example \
  --header 'Authorization: Bearer <token>'

Returns a single consent statement by id or a not-found error.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Consent statement identifier.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Consent statement response.

Media type application/json
object
id
required
string
tenant_id
required
string
slug
required
string
category
required
string
legal_basis
required
string
processing_purpose
string | null
record_retention_days
integer | null
withdrawal_allowed
integer
Allowed values: 0 1
withdrawal_impact
string | null
reconsent_on_version_change
integer
Allowed values: 0 1
reconsent_interval_days
integer | null
display_order
required
integer
is_active
required
integer
Allowed values: 0 1
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
Example 
{
  "id": "stmt_123",
  "tenant_id": "acme",
  "slug": "terms-of-service",
  "category": "legal",
  "legal_basis": "contract",
  "processing_purpose": "Account terms acceptance.",
  "record_retention_days": 2555,
  "withdrawal_allowed": 1,
  "withdrawal_impact": "Account access may be limited if withdrawn.",
  "reconsent_on_version_change": 1,
  "reconsent_interval_days": 365,
  "display_order": 10,
  "is_active": 1,
  "created_at": 1770000000000,
  "updated_at": 1770000000000
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}