Rehive logo
Powered by Redocly

legal-terms

List legal terms

SecurityapiAuth
Request
query Parameters
group
string
name
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string
Responses
200
get/3/admin/legal-terms/
Request samples 
rehive.admin.legal_terms.get()
Response samples
application/json
{}

Create legal terms

SecurityapiAuth
Request
Request Body schema:
required
name
required
string <= 100 characters
description
string or null <= 255 characters
groups
Array of strings or null
archived
boolean
Default: false
Responses
201
post/3/admin/legal-terms/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "groups": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve legal terms

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
get/3/admin/legal-terms/{id}/
Request samples 
rehive.admin.legal_terms.get(legal_terms_id)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update legal terms

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
required
name
required
string <= 100 characters
description
string or null <= 255 characters
groups
Array of strings or null
archived
boolean
Default: false
Responses
200
put/3/admin/legal-terms/{id}/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "groups": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update legal terms

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
name
string <= 100 characters
description
string or null <= 255 characters
groups
Array of strings or null
archived
boolean
Default: false
Responses
200
patch/3/admin/legal-terms/{id}/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "groups": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete legal terms

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
delete/3/admin/legal-terms/{id}/
Request samples 
rehive.admin.legal_terms.delete(
  legal_terms_id
)
Response samples
application/json
{
  • "status": "sucess"
}

List legal terms versions

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/legal-terms/{id}/versions/
Request samples 
rehive.admin.legal_terms.obj(legal_terms_id).versions.get()
Response samples
application/json
{}

Create legal terms version

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
note
string or null <= 250 characters
content
string or null
url
string or null <uri> <= 200 characters
archived
boolean
Default: false
Responses
201
post/3/admin/legal-terms/{id}/versions/
Request samples
{}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve legal terms version

SecurityapiAuth
Request
path Parameters
term_id
required
string^\d+$
version_id
required
string^\d+$
Responses
200
get/3/admin/legal-terms/{term_id}/versions/{version_id}/
Request samples 
rehive.admin.legal_terms.obj(legal_terms_id).versions.get(
  version_id
)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update legal terms version

SecurityapiAuth
Request
path Parameters
term_id
required
string^\d+$
version_id
required
string^\d+$
Request Body schema:
note
string or null <= 250 characters
content
string or null
url
string or null <uri> <= 200 characters
archived
boolean
Default: false
Responses
200
put/3/admin/legal-terms/{term_id}/versions/{version_id}/
Request samples
{}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update legal terms version

SecurityapiAuth
Request
path Parameters
term_id
required
string^\d+$
version_id
required
string^\d+$
Request Body schema:
note
string or null <= 250 characters
content
string or null
url
string or null <uri> <= 200 characters
archived
boolean
Default: false
Responses
200
patch/3/admin/legal-terms/{term_id}/versions/{version_id}/
Request samples
{}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete legal terms version

SecurityapiAuth
Request
path Parameters
term_id
required
string^\d+$
version_id
required
string^\d+$
Responses
200
delete/3/admin/legal-terms/{term_id}/versions/{version_id}/
Request samples 
rehive.admin.legal_terms.obj(legal_terms_id).versions.delete(
  version_id
)
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to metrics