Content

Lists / Get one by key

Return specific list by unique_key.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/lists/key/{unique_key}

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source
unique_key	String
include_view_states	Boolean
include_fields	Boolean
include_fields_multi_options	Boolean

Request body example

Response status: 200 (OK)

Response type: DTO_list

Wrapper:

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	ReadOnly	Description
list_fields	DTO_list_field[]		List fields
group_access	DTO_group_access[]		Group access
sys_tags	DTO_reference[]		Label can be used on POST/PUT to create new tags
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
id	Int32	ReadOnly	Leave empty on input
type	ENUM list_type	ReadOnly	Type
highest_group_permission	ENUM group_permission	ReadOnly	Highest group permission
name	String		Name
unique_key	String		Unique key
description	String		Description
entries_count	Int32		Entries count
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Name	Type	Description
id	Int32	Id
is_required	Boolean	Is required
is_unique_identifier	Boolean	Is unique identifier

Name	Type	ReadOnly	Description
permission	ENUM group_permission		Permission
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

GET Lists / Get one

DELETE Lists / Delete