Skip to content
EthicsPortal API

Read whistleblowing channel metadata

GET
/organizations/{organization_id}/whistleblower/portal.json
curl --request GET \
  --url https://secure.ethicsportal.eu/organizations/example/whistleblower/portal.json \
  --header 'Authorization: Bearer <token>'

Return the whistleblowing channel of one organisation: its ID, whether it is active and the URL of its online reporting form. Any member’s personal token can read it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization_id
required
string

Obfuscated organisation ID returned by identity.

Header Parameters

Section titled “Header Parameters”
If-None-Match
string

The ETag of a response you already hold. If nothing changed, the response is 304 Not Modified with no body. It still counts toward rate limits and, where reads are audited, the audit trail.

Responses

Section titled “Responses”

200

Section titled “200”

Metadata only. Dates describe recorded workflow state, not proof of notification delivery.

Media typeapplication/json
object
id
required
string
active
required
boolean
reporting_form_url
required
string format: uri
configuration_url
required
string format: uri
documents_url
required
string format: uri

Example 

{
  "id": "QATEST12",
  "active": true,
  "reporting_form_url": "https://secure.ethicsportal.eu/p/QATEST12",
  "configuration_url": "https://secure.ethicsportal.eu/organizations/gHiJkl/whistleblower/portal/configuration.json",
  "documents_url": "https://secure.ethicsportal.eu/organizations/gHiJkl/whistleblower/documents.json"
}

Headers

Section titled “Headers”
ETag
string

Weak validator of this response body. Send it back as If-None-Match.

304

Section titled “304”

Not modified since the ETag sent in If-None-Match. No body.

400

Section titled “400”

Invalid query or cursor

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_token forbidden insufficient_scope not_found invalid_request agreement_required rate_limited idempotency_key_reused idempotency_key_in_progress not_retryable channel_inactive invitation_unavailable already_subscribed no_subscription
feedback_url
required

Where to tell EthicsPortal what went wrong: POST product feedback here with the same token.

string format: uri

Example 

{
  "error": {
    "code": "invalid_request",
    "feedback_url": "https://secure.ethicsportal.eu/me/feedback.json"
  }
}

401

Section titled “401”

Missing, invalid, expired or revoked bearer token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_token forbidden insufficient_scope not_found invalid_request agreement_required rate_limited idempotency_key_reused idempotency_key_in_progress not_retryable channel_inactive invitation_unavailable already_subscribed no_subscription
feedback_url
required

Where to tell EthicsPortal what went wrong: POST product feedback here with the same token.

string format: uri

Example 

{
  "error": {
    "code": "invalid_token",
    "feedback_url": "https://secure.ethicsportal.eu/me/feedback.json"
  }
}

Headers

Section titled “Headers”
WWW-Authenticate
string

Bearer realm=“EthicsPortal”

403

Section titled “403”

Required agreement not accepted or permission denied

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_token forbidden insufficient_scope not_found invalid_request agreement_required rate_limited idempotency_key_reused idempotency_key_in_progress not_retryable channel_inactive invitation_unavailable already_subscribed no_subscription
feedback_url
required

Where to tell EthicsPortal what went wrong: POST product feedback here with the same token.

string format: uri

Example 

{
  "error": {
    "code": "agreement_required",
    "feedback_url": "https://secure.ethicsportal.eu/me/feedback.json"
  }
}

404

Section titled “404”

Missing or inaccessible organisation or resource, or feature disabled

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_token forbidden insufficient_scope not_found invalid_request agreement_required rate_limited idempotency_key_reused idempotency_key_in_progress not_retryable channel_inactive invitation_unavailable already_subscribed no_subscription
feedback_url
required

Where to tell EthicsPortal what went wrong: POST product feedback here with the same token.

string format: uri

Example 

{
  "error": {
    "code": "not_found",
    "feedback_url": "https://secure.ethicsportal.eu/me/feedback.json"
  }
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_token forbidden insufficient_scope not_found invalid_request agreement_required rate_limited idempotency_key_reused idempotency_key_in_progress not_retryable channel_inactive invitation_unavailable already_subscribed no_subscription
feedback_url
required

Where to tell EthicsPortal what went wrong: POST product feedback here with the same token.

string format: uri

Example 

{
  "error": {
    "code": "rate_limited",
    "feedback_url": "https://secure.ethicsportal.eu/me/feedback.json"
  }
}

Headers

Section titled “Headers”
Retry-After
string

60 seconds