List all data policies

GET 
/config/policies

This endpoint reads all data policies defined in the consent building block.

Request

Query Parameters

revisionId stringrequired

An object with ID revisionId

offset integerrequired

Number of records to skip for pagination.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Responses

200

A list of Policy objects readable for the current session's credentials.

Response Headers

application/json

Schema

Schema

pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

policies object[]
Array [
id string
name stringrequired
Name of the policy
version string
Version of the policy (it can follow the semver format)
url stringrequired
Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time
jurisdiction string
Jurisdiction
industrySector string
Industry sector
dataRetentionPeriodDays integer
Data retention period in days
geographicRestriction string
Geographic restriction
storageLocation string
Storage location
thirdPartyDataSharing boolean
Third party data sharing
]

Example (from schema)

{
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  },
  "policies": [
    {
      "id": "65471222e8c7c3bb3c2c7701",
      "name": "Default data policy",
      "version": "1.0.0",
      "url": "https://example.com/privacy-policy",
      "jurisdiction": "EU",
      "industrySector": "Healthcare",
      "dataRetentionPeriodDays": 365,
      "geographicRestriction": "EU",
      "storageLocation": "EU",
      "thirdPartyDataSharing": true
    }
  ]
}

400

bad input parameter

Response Headers

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...