MasterRights.list

Returns all defined MasterRights

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted MasterRights are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

filter

object

optional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-op

object

optional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of MasterRights

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (MasterRight) {139}]

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

access_account_relation_types

boolean

optional

Controls access to resource.

Example:

false

access_accounts

boolean

optional

Controls access to resource.

Example:

false

access_appointment_scheduler

boolean

optional

Controls access to resource.

Example:

false

access_appointment_scheduler_management

boolean

optional

Controls access to resource.

Example:

false

access_approval_processes

boolean

optional

Controls access to resource.

Example:

false

access_approval_processes_management

boolean

optional

Controls access to resource.

Example:

false

access_approvals

boolean

optional

Controls access to resource.

Example:

false

access_archive

boolean

optional

Controls access to resource.

Example:

false

access_audit

boolean

optional

Controls access to resource.

Example:

false

access_audit_log

boolean

optional

Controls access to resource.

Example:

false

access_bulk_update

boolean

optional

Controls access to resource.

Example:

false

access_calling

boolean

optional

Controls access to resource.

Example:

false

access_calling_company_phone

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All

Allowed values:

012

Example:

access_calling_purchase_phone

boolean

optional

Controls access to resource.

Example:

false

access_company_emails

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All

Allowed values:

012

Example:

access_contacts

boolean

optional

Controls access to resource.

Example:

false

access_document_management

boolean

optional

Controls access to resource.

Example:

false

access_document_management_company

boolean

optional

Controls access to resource.

Example:

false

access_document_management_record

boolean

optional

Controls access to resource.

Example:

false

access_duplicate_checker

boolean

optional

Controls access to resource.

Example:

false

access_entity_account

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_account_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_account_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_account_private

boolean

optional

Controls access to resource.

Example:

false

access_entity_account_tag_create

boolean

optional

Controls access to resource.

Example:

false

access_entity_account_types

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

access_entity_appointment

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_appointment_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_appointment_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_contact

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_contact_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_contact_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_contact_private

boolean

optional

Controls access to resource.

Example:

false

access_entity_contact_tag_create

boolean

optional

Controls access to resource.

Example:

false

access_entity_contact_types

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

access_entity_dashboard

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_dashboard_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_dashboard_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_dashboard_sharing_custom

boolean

optional

Controls access to resource.

Example:

false

access_entity_dashboard_sharing_public

boolean

optional

Controls access to resource.

Example:

false

access_entity_email_content_share_mode

enum<integer>

optional

Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly

Allowed values:

012

Example:

access_entity_email_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_email_sequence

enum<integer>

optional

Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess

Allowed values:

123

Example:

access_entity_email_template

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_email_template_create_delete_folder

boolean

optional

Controls access to resource.

Example:

false

access_entity_email_template_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_email_template_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_email_template_sharing_custom

boolean

optional

Controls access to resource.

Example:

false

access_entity_email_template_sharing_public

boolean

optional

Controls access to resource.

Example:

false

access_entity_forecast

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_forecast_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_forecast_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_forecast_edit_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_forecast_sharing_custom

boolean

optional

Controls access to resource.

Example:

false

access_entity_forecast_sharing_public

boolean

optional

Controls access to resource.

Example:

false

access_entity_form_view

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_form_view_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_form_view_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_form_view_sharing_custom

boolean

optional

Controls access to resource.

Example:

false

access_entity_form_view_sharing_public

boolean

optional

Controls access to resource.

Example:

false

access_entity_lead

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_lead_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_lead_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_lead_private

boolean

optional

Controls access to resource.

Example:

false

access_entity_lead_tag_create

boolean

optional

Controls access to resource.

Example:

false

access_entity_lead_types

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

access_entity_message_tag_create

boolean

optional

Controls access to resource.

Example:

false

access_entity_oppty

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_oppty_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_oppty_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_oppty_private

boolean

optional

Controls access to resource.

Example:

false

access_entity_oppty_tag_create

boolean

optional

Controls access to resource.

Example:

false

access_entity_pipeline

enum<integer>

optional

Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments

Allowed values:

0123

Example:

access_entity_process

enum<integer>

optional

Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess

Allowed values:

123

Example:

access_entity_profile

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_profile_default_screen_profiles

object

optional

Field containing json.

access_entity_profile_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_profile_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_profile_sharing_custom

boolean

optional

Controls access to resource.

Example:

false

access_entity_profile_sharing_public

boolean

optional

Controls access to resource.

Example:

false

access_entity_project

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_project_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_project_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_project_private

boolean

optional

Controls access to resource.

Example:

false

access_entity_project_tag_create

boolean

optional

Controls access to resource.

Example:

false

access_entity_quote

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_quote_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_quote_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_quote_types

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

access_entity_report

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_report_create_delete_folder

boolean

optional

Controls access to resource.

Example:

false

access_entity_report_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_report_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_report_sharing_custom

boolean

optional

Controls access to resource.

Example:

false

access_entity_report_sharing_public

boolean

optional

Controls access to resource.

Example:

false

access_entity_target

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All

Allowed values:

014

Example:

access_entity_target_delete_not_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_target_delete_owned

boolean

optional

Controls access to resource.

Example:

false

access_entity_task

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All

Allowed values:

01234

Example:

access_entity_task_delete

boolean

optional

Controls access to resource.

Example:

false

access_entity_task_direction

enum<integer>

optional

Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All

Allowed values:

123456

Example:

access_entity_task_unassigned

boolean

optional

Controls access to resource.

Example:

false

access_export

boolean

optional

Controls access to resource.

Example:

false

access_feeds

boolean

optional

Controls access to resource.

Example:

false

access_foreign_currencies

boolean

optional

Controls access to resource.

Example:

false

access_form_and_fields

boolean

optional

Controls access to resource.

Example:

false

access_global_settings

boolean

optional

Controls access to resource.

Example:

false

access_home_screen

boolean

optional

Controls access to resource.

Example:

false

access_import

boolean

optional

Controls access to resource.

Example:

false

access_insights

boolean

optional

Controls access to resource.

Example:

false

access_leads

boolean

optional

Controls access to resource.

Example:

false

access_online_forms

boolean

optional

Controls access to resource.

Example:

false

access_online_forms_management

boolean

optional

Controls access to resource.

Example:

false

access_opportunity

boolean

optional

Controls access to resource.

Example:

false

access_pipeline_configuration

boolean

optional

Controls access to resource.

Example:

false

access_print

boolean

optional

Controls access to resource.

Example:

false

access_products_services

boolean

optional

Controls access to resource.

Example:

false

access_projects

boolean

optional

Controls access to resource.

Example:

false

access_quotes

boolean

optional

Controls access to resource.

Example:

false

access_sales_roles

boolean

optional

Controls access to resource.

Example:

false

access_security

boolean

optional

Controls access to resource.

Example:

false

access_units

boolean

optional

Controls access to resource.

Example:

false

access_user_and_roles

boolean

optional

Controls access to resource.

Example:

false

access_whats_app_company_phone

enum<integer>

optional

Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All

Allowed values:

012

Example:

name

string

required

Name of the entity and its default text representation.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

allowed_pipelines

array[string <uri>]

optional

Relations to Pipelines.

allowed_lead_types

array[string <uri>]

optional

Relations to LeadTypes.

allowed_quote_types

array[string <uri>]

optional

Relations to QuoteTypes.

allowed_account_types

array[string <uri>]

optional

Relations to AccountTypes.

allowed_contact_types

array[string <uri>]

optional

Relations to ContactTypes.

allowed_company_emails

array[string <uri>]

optional

Relations to CompanyEmails.

allowed_company_phones

array[string <uri>]

optional

Relations to Phones.

custom_entities

string <binary>

optional

Example:

blob

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
    "success": true,
    "data": [
        {
            "is_delete_protected": false,
            "id": "01234567-abcd-dcba-ffff-000000000000",
            "is_deleted": false,
            "modified": "2019-01-01T00:00:00",
            "created": "2019-01-01T00:00:00",
            "access_account_relation_types": false,
            "access_accounts": false,
            "access_appointment_scheduler": false,
            "access_appointment_scheduler_management": false,
            "access_approval_processes": false,
            "access_approval_processes_management": false,
            "access_approvals": false,
            "access_archive": false,
            "access_audit": false,
            "access_audit_log": false,
            "access_bulk_update": false,
            "access_calling": false,
            "access_calling_company_phone": 0,
            "access_calling_purchase_phone": false,
            "access_company_emails": 0,
            "access_contacts": false,
            "access_document_management": false,
            "access_document_management_company": false,
            "access_document_management_record": false,
            "access_duplicate_checker": false,
            "access_entity_account": 0,
            "access_entity_account_delete": false,
            "access_entity_account_direction": 1,
            "access_entity_account_private": false,
            "access_entity_account_tag_create": false,
            "access_entity_account_types": 1,
            "access_entity_appointment": 0,
            "access_entity_appointment_delete": false,
            "access_entity_appointment_direction": 1,
            "access_entity_contact": 0,
            "access_entity_contact_delete": false,
            "access_entity_contact_direction": 1,
            "access_entity_contact_private": false,
            "access_entity_contact_tag_create": false,
            "access_entity_contact_types": 1,
            "access_entity_dashboard": 0,
            "access_entity_dashboard_delete_not_owned": false,
            "access_entity_dashboard_delete_owned": false,
            "access_entity_dashboard_sharing_custom": false,
            "access_entity_dashboard_sharing_public": false,
            "access_entity_email_content_share_mode": 0,
            "access_entity_email_delete_not_owned": false,
            "access_entity_email_sequence": 1,
            "access_entity_email_template": 0,
            "access_entity_email_template_create_delete_folder": false,
            "access_entity_email_template_delete_not_owned": false,
            "access_entity_email_template_delete_owned": false,
            "access_entity_email_template_sharing_custom": false,
            "access_entity_email_template_sharing_public": false,
            "access_entity_forecast": 0,
            "access_entity_forecast_delete_not_owned": false,
            "access_entity_forecast_delete_owned": false,
            "access_entity_forecast_edit_not_owned": false,
            "access_entity_forecast_sharing_custom": false,
            "access_entity_forecast_sharing_public": false,
            "access_entity_form_view": 0,
            "access_entity_form_view_delete_not_owned": false,
            "access_entity_form_view_delete_owned": false,
            "access_entity_form_view_sharing_custom": false,
            "access_entity_form_view_sharing_public": false,
            "access_entity_lead": 0,
            "access_entity_lead_delete": false,
            "access_entity_lead_direction": 1,
            "access_entity_lead_private": false,
            "access_entity_lead_tag_create": false,
            "access_entity_lead_types": 1,
            "access_entity_message_tag_create": false,
            "access_entity_oppty": 0,
            "access_entity_oppty_delete": false,
            "access_entity_oppty_direction": 1,
            "access_entity_oppty_private": false,
            "access_entity_oppty_tag_create": false,
            "access_entity_pipeline": 0,
            "access_entity_process": 1,
            "access_entity_profile": 0,
            "access_entity_profile_default_screen_profiles": {},
            "access_entity_profile_delete_not_owned": false,
            "access_entity_profile_delete_owned": false,
            "access_entity_profile_sharing_custom": false,
            "access_entity_profile_sharing_public": false,
            "access_entity_project": 0,
            "access_entity_project_delete": false,
            "access_entity_project_direction": 1,
            "access_entity_project_private": false,
            "access_entity_project_tag_create": false,
            "access_entity_quote": 0,
            "access_entity_quote_delete": false,
            "access_entity_quote_direction": 1,
            "access_entity_quote_types": 1,
            "access_entity_report": 0,
            "access_entity_report_create_delete_folder": false,
            "access_entity_report_delete_not_owned": false,
            "access_entity_report_delete_owned": false,
            "access_entity_report_sharing_custom": false,
            "access_entity_report_sharing_public": false,
            "access_entity_target": 0,
            "access_entity_target_delete_not_owned": false,
            "access_entity_target_delete_owned": false,
            "access_entity_task": 0,
            "access_entity_task_delete": false,
            "access_entity_task_direction": 1,
            "access_entity_task_unassigned": false,
            "access_export": false,
            "access_feeds": false,
            "access_foreign_currencies": false,
            "access_form_and_fields": false,
            "access_global_settings": false,
            "access_home_screen": false,
            "access_import": false,
            "access_insights": false,
            "access_leads": false,
            "access_online_forms": false,
            "access_online_forms_management": false,
            "access_opportunity": false,
            "access_pipeline_configuration": false,
            "access_print": false,
            "access_products_services": false,
            "access_projects": false,
            "access_quotes": false,
            "access_sales_roles": false,
            "access_security": false,
            "access_units": false,
            "access_user_and_roles": false,
            "access_whats_app_company_phone": 0,
            "name": "string",
            "revision": 1,
            "allowed_pipelines": [
                "http://example.com"
            ],
            "allowed_lead_types": [
                "http://example.com"
            ],
            "allowed_quote_types": [
                "http://example.com"
            ],
            "allowed_account_types": [
                "http://example.com"
            ],
            "allowed_contact_types": [
                "http://example.com"
            ],
            "allowed_company_emails": [
                "http://example.com"
            ],
            "allowed_company_phones": [
                "http://example.com"
            ],
            "custom_entities": "blob"
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Server Error

Request

Request samples

Responses