Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Documents

Get List of Documents

Use this API to retrieve a list of policies, standards, procedures, or privacy notices by the specified compliance document type.

get/v1/{complianceType}/list

Path parameters

complianceType'policies' | 'standards' | 'procedures' | 'privacynotices' required

The type of compliance document.

Query parameters

pageinteger

The page number of the results.

sizeinteger

The number of results per page.

sortstring

The sort criteria that dictates the order of the results.

Response

OK

guidstring uuid

The unique identifier of the policy, standard, procedure, or privacy notice.

organizationNamestring

The name of the organization responsible for the policy, standard, procedure, or privacy notice.

namestring

The name of the policy, standard, procedure, or privacy notice.

descriptionstring

The description of the policy, standard, procedure, or privacy notice.

effectiveDatestring date

The date on which the policy, standard, procedure, or privacy notice takes effect.

expirationDatestring date

The date on which the policy, standard, procedure, or privacy notice expires.

idinteger

The unique identifier of the policy, standard, procedure, or privacy notice.

defaultLanguageCodestring

The default language of the policy, standard, procedure, or privacy notice.

For more information, see Supported Languages and HTML Language Codes.

createdDatestring date-time

The date and time on which the policy, standard, procedure, or privacy notice was created.

organizationIdstring uuid

The unique identifier of the organization responsible for the policy, standard, procedure, or privacy notice.

Example response

[
  {
    "effectiveDate": "2024-12-13",
    "expirationDate": "2024-12-31"
  }
]