Skip to content
AcrivaDocs

ListLegalHolds

GET
/api/v1/t/{tenant}/compliance/legal-holds
curl --request GET \
  --url 'https://example.com/api/v1/t/example/compliance/legal-holds?state=Active'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Query Parameters

Section titled “Query Parameters”
state
Allowed values: Active Lifted All
cursor
string
limit
integer format: int32

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
reason
required
string
createdBy
required
string format: uuid
createdAt
required
string format: date-time
liftedBy
required
null | string format: uuid
liftedAt
required
null | string format: date-time
liftReason
required
null | string
documentCount
required
integer format: int32
fileCount
required
integer format: int32
version
required
integer format: uint32
filling
boolean
nextCursor
required
null | string
Example
{
  "items": [
    {
      "filling": false
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}