Public

List public companies

Request

query Parameters

id	string
id__contains	string
name	string
name__contains	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/public/companies/

Response samples

application/json

{"status": "string",
"data": {"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"config": { },
"settings": {"allow_session_durations": true,
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
]
},
"services": "string",
"mode": "test",
"status": "pending",
"created": "string",
"updated": "string"
}
]
}
}

Retrieve public company

Request

path Parameters

required

string

Responses

200

get/public/companies/{id}/

Response samples

application/json

{"status": "string",
"data": {"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"config": { },
"settings": {"allow_session_durations": true,
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
]
},
"services": "string",
"mode": "test",
"status": "pending",
"created": "string",
"updated": "string"
}
}

List public company groups

Request

path Parameters

required

string

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/public/companies/{id}/groups/

Response samples

application/json

{"status": "string",
"data": {"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"name": "string",
"label": "string",
"section": "system",
"description": "string",
"icon": "http://example.com",
"default": true
}
]
}
}

Retrieve public company group

Request

path Parameters

group_name required	string
id required	string

Responses

200

get/public/companies/{id}/groups/{group_name}/

Response samples

application/json

{"status": "string",
"data": {"name": "string",
"label": "string",
"section": "system",
"description": "string",
"icon": "http://example.com",
"default": true
}
}

List public company legal terms

Request

path Parameters

required

string

query Parameters

name	string
type	string
group	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/public/companies/{id}/legal-terms/

Response samples

application/json

{"status": "string",
"data": {"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": "string",
"versions": [{"id": 0,
"version": 0
}
],
"created": "string",
"updated": "string"
}
]
}
}

Retrieve public company legal terms

Request

path Parameters

id required	string
term_id required	string

Responses

200

get/public/companies/{id}/legal-terms/{term_id}/

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": "string",
"versions": [{"id": 0,
"version": 0
}
],
"created": "string",
"updated": "string"
}
}

List public company legal term versions

Request

path Parameters

id required	string
term_id required	string

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/public/companies/{id}/legal-terms/{term_id}/versions/

Response samples

application/json

{"status": "string",
"data": {"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": "string",
"updated": "string"
}
]
}
}

Retrieve public company legal term version

Request

path Parameters

id required	string
term_id required	string
version_id required	string

Responses

200

get/public/companies/{id}/legal-terms/{term_id}/versions/{version_id}/

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": "string",
"updated": "string"
}
}

List public legal terms

Request

query Parameters

name	string
type	string
group	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/public/legal-terms/

Response samples

application/json

{"status": "string",
"data": {"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": "string",
"versions": [{"id": 0,
"version": 0
}
],
"created": "string",
"updated": "string"
}
]
}
}

Retrieve public legal terms

Request

path Parameters

term_id

required

string

Responses

200

get/public/legal-terms/{term_id}/

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": "string",
"versions": [{"id": 0,
"version": 0
}
],
"created": "string",
"updated": "string"
}
}

List public legal term versions

Request

path Parameters

term_id

required

string

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/public/legal-terms/{term_id}/versions/

Response samples

application/json

{"status": "string",
"data": {"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": "string",
"updated": "string"
}
]
}
}

Retrieve public legal term version

Request

path Parameters

term_id required	string
version_id required	string

Responses

200

get/public/legal-terms/{term_id}/versions/{version_id}/

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": "string",
"updated": "string"
}
}

➔ Next to Subtypes