Skip to main content

Get consent types

Get consent types for a project.

Path Parameters
organizationId uuid REQUIRED
projectId uuid REQUIRED
Query Parameters
category
subcategory undefined[]
label
name string

Possible values: length ≤ 100

url uri
version number
sort string
order string
offset integer
limit integer

Possible values: 1 ≤ value ≤ 1000

status
Responses
200

Default Response

Schema OPTIONAL
offset integer OPTIONAL
count integer OPTIONAL
total integer OPTIONAL
items object[] OPTIONAL
createdAt OPTIONAL
updatedAt OPTIONAL
id uuid
organization OPTIONAL
project
category OPTIONAL
subcategory OPTIONAL
label string OPTIONAL

Possible values: length ≤ 128, Value must match regular expression [a-z0-9_*]{1,128}$

version integer
dateCreated date-time OPTIONAL
dateUpdated date-time OPTIONAL
name string

Possible values: length ≤ 100

description string

Possible values: length ≤ 2000

document string OPTIONAL

Possible values: length ≤ 5000000

url uri OPTIONAL
readOnly boolean OPTIONAL
validStates string[] OPTIONAL

Possible values: [implied, viewed, accepted, declined]

status string OPTIONAL

Possible values: [active, archived, obsolete, test]

consentDuration string OPTIONAL
required boolean OPTIONAL
requireReacceptVersion integer OPTIONAL
400

Bad request response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string

Description of the error encounted.

401

Unauthorized response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string
403

Forbidden response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string
message string
404

Not found response.

Schema OPTIONAL
statusCode int32
error string
message string
422

Unprocessable Entity response.

Schema OPTIONAL
statusCode int32
error string
message string

Description of the error encounted.

500

Internal server error response.

Schema OPTIONAL
statusCode int32
error string
message string

Will always be "Internal Server Error"