Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.
200 -
Field
Type
Description
checklist
object (free-form)
completion
object
completion.uuid
string (uuid)
completion.is_completed
boolean
Whether all required questions have been answered
completion.completion_percentage
number (double)
completion.unanswered_required_questions
array of anys
completion.checklist_name
string
completion.checklist_description
string
completion.created
string (date-time)
completion.modified
string (date-time)
questions
array of objects
questions.uuid
string (uuid)
questions.description
string
questions.user_guidance
string
questions.question_type
any
Type of question and expected answer format
questions.required
boolean
questions.order
integer
questions.existing_answer
object (free-form)
questions.question_options
array of anys
questions.min_value
string (decimal)
Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value
string (decimal)
Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types
any
List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types
any
List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb
integer
Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count
integer
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info
object (free-form)
400 -
404 -
Checklist review
Get checklist with questions and existing answers including review logic (reviewers only).
Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value
string (decimal)
Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types
any
List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types
any
List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb
integer
Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count
integer
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info
object (free-form)
questions.operator
any
questions.review_answer_value
any
Answer value that trigger review.
questions.always_requires_review
boolean
This question always requires review regardless of answer
UUID of the parent object (e.g., customer UUID for new projects)
200 -
Field
Type
Description
checklist
object (free-form)
questions
array of objects
questions.uuid
string (uuid)
questions.required
boolean
questions.description
string
questions.user_guidance
string
Additional guidance text visible to users when answering and reviewing
questions.question_options
array of objects
questions.question_options.uuid
string (uuid)
questions.question_options.label
string
questions.question_options.order
integer
questions.question_type
any
Type of question and expected answer format
questions.order
integer
questions.min_value
string (decimal)
Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value
string (decimal)
Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types
any
List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types
any
List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb
integer
Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count
integer
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator
any
questions.review_answer_value
any
Answer value that trigger review.
questions.always_requires_review
boolean
This question always requires review regardless of answer
questions.guidance_answer_value
any
Answer value that triggers display of user guidance.
questions.guidance_operator
any
Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance
boolean
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator
any
Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions
array of objects
initial_visible_questions.uuid
string (uuid)
initial_visible_questions.required
boolean
initial_visible_questions.description
string
initial_visible_questions.user_guidance
string
Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options
array of objects
initial_visible_questions.question_options.uuid
string (uuid)
initial_visible_questions.question_options.label
string
initial_visible_questions.question_options.order
integer
initial_visible_questions.question_type
any
Type of question and expected answer format
initial_visible_questions.order
integer
initial_visible_questions.min_value
string (decimal)
Minimum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.max_value
string (decimal)
Maximum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.allowed_file_types
any
List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types
any
List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb
integer
Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count
integer
Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator
any
initial_visible_questions.review_answer_value
any
Answer value that trigger review.
initial_visible_questions.always_requires_review
boolean
This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value
any
Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator
any
Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance
boolean
Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator