REST API Users, roles, units and permissionsMasterRights

MasterRights

MasterRights: list, get, create, update and delete, plus batch operations.

The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.

Method	Path	Operation
GET	`/entities/MasterRights`	List MasterRights
POST	`/entities/MasterRights`	Create MasterRight
GET	`/entities/MasterRights/{id}`	Get MasterRight
PATCH	`/entities/MasterRights/{id}`	Update MasterRight
DEL	`/entities/MasterRights/{id}`	Delete MasterRight
POST	`/entities/MasterRights/batch-modify`	Create or update MasterRights in a batch
POST	`/entities/MasterRights/batch-delete`	Delete MasterRights in a batch
POST	`/entities/MasterRights/batch-restore`	Restore deleted MasterRights

GET List MasterRights

Returns the MasterRights the API application can read, one page at a time. In the list envelope, total counts every match and page_info pages through them.

Query parameters

Name	Type	Description
`include-deleted`	boolean	Include soft-deleted records. Lists only; get-by-id refuses it.
`first`	integer	Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
`last`	integer	Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100.
`before`	string	Cursor from `page_info.start_cursor`, to page backwards. URL-encode it.
`after`	string	Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`.
`order-by`	string	Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields.
`filter`	object	`filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.
`filter-op`	object	`filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.
`load-only`	string	Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Responses

200 Page of MasterRight records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights",
    params={
      "first": "10",
      "filter[name]": "north",
      "filter-op[name]": "icontains"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create MasterRight

Creates one record and answers 201 with it.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The new record's fields. Relations are set by id. Schema createMasterRightInput; the fields are in MasterRight fields. Required: name.

Responses

201 The created MasterRight record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind master right"
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Northwind master right'
  })
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "name": "Northwind master right"
    }
)

GET Get MasterRight

Returns one record by id. expand returns related records inline instead of their URIs.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the MasterRight record to retrieve. Required

Query parameters

Name	Type	Description
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The MasterRight record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH Update MasterRight

Changes the fields you send and leaves the rest as they are; there is no PUT.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the MasterRight record to update. Required

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The fields to change. Schema updateMasterRightInput; the fields are in MasterRight fields.

Responses

200 The changed MasterRight record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind master right (renamed)"
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001', {
  method: 'PATCH',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Northwind master right (renamed)'
  })
})

import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "name": "Northwind master right (renamed)"
    }
)

DEL Delete MasterRight

Deletes one record and answers with its id.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the MasterRight record to delete. Required

Responses

200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001', {
  method: 'DELETE',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.delete(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/6c000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create or update MasterRights in a batch

An item with an id updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with rollback-method=1 the response has an id or an error for each item, in input order.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of records: an item with an id updates, an item without one creates. Schema batchMasterRightInput; the fields are in MasterRight fields. Required: name.

Responses

200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "name": "Northwind master right"
  },
  {
    "id": "6c000000-0000-4000-a000-000000000001",
    "name": "Northwind master right (renamed)"
  }
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-modify', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      name: 'Northwind master right'
    },
    {
      id: '6c000000-0000-4000-a000-000000000001',
      name: 'Northwind master right (renamed)'
    }
  ])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-modify",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      {
        "name": "Northwind master right"
      },
      {
        "id": "6c000000-0000-4000-a000-000000000001",
        "name": "Northwind master right (renamed)"
      }
    ]
)

POST Delete MasterRights in a batch

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "6c000000-0000-4000-a000-000000000001",
  "6c000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['6c000000-0000-4000-a000-000000000001', '6c000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-delete",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "6c000000-0000-4000-a000-000000000001",
      "6c000000-0000-4000-a000-000000000002"
    ]
)

POST Restore deleted MasterRights

Restores the deleted records whose ids are in the body, a JSON array.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "6c000000-0000-4000-a000-000000000001",
  "6c000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-restore', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['6c000000-0000-4000-a000-000000000001', '6c000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/MasterRights/batch-restore",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "6c000000-0000-4000-a000-000000000001",
      "6c000000-0000-4000-a000-000000000002"
    ]
)

MasterRight fields

Field	Type	Notes
`id`	uuid	Read-only Unique identifier of entity.
`name`	string	Required on create Name of the entity and its default text representation.
`access_account_relation_types`	boolean	Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
`access_accounts`	boolean	Shows the Accounts screen to users with this role.
`access_ai_automatizer`	boolean	Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
`access_ai_online_forms`	boolean	Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
`access_ai_record_detail`	boolean	Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
`access_ai_record_enrichment`	boolean	Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
`access_ai_relationship_charts`	boolean	Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
`access_ai_reports`	boolean	Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
`access_ai_smart_field`	boolean	Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
`access_appointment_scheduler`	boolean	Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space.
`access_appointment_scheduler_management`	boolean	Allows users with this role to manage appointment schedules of other users.
`access_approval_processes`	boolean	Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
`access_approval_processes_management`	boolean	Allows users with this role to manage approval processes owned by other users.

Show all 178 fields

Field	Type	Notes
`access_approvals`	boolean	Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
`access_archive`	boolean	Allows users with this role to open the Archive screens listing lost, closed and archived records.
`access_audit`	boolean	Allows users with this role to open the Audit screen.
`access_audit_log`	boolean	Allows users with this role to view the audit log of changes made in the space.
`access_bottom_menu_customization`	boolean	Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar").
`access_bulk_update`	boolean	Allows users with this role to update many records at once with bulk update.
`access_calling`	boolean	Allows users with this role to make calls through the calling integration, when the feature is enabled for the space.
`access_calling_company_phone`	integer	Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowed_company_phones (Selected) or all (All).0 NoAccess · 1 Selected · 2 All
`access_calling_purchase_phone`	boolean	Allows users with this role to purchase and manage company phone numbers for the calling integration.
`access_company_emails`	integer	Which shared company email accounts users with this role can send from: none (NoAccess), those in allowed_company_emails (Selected) or all (All).0 NoAccess · 1 Selected · 2 All
`access_contacts`	boolean	Shows the Contacts screen to users with this role.
`access_document_management`	boolean	Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
`access_document_management_company`	boolean	Allows users with this role to manage company documents and folders that are not tied to a record.
`access_document_management_record`	boolean	Allows users with this role to create and edit the document folders used for records.
`access_duplicate_checker`	boolean	Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
`access_email_notification_enforcement`	boolean	When true, users with this role get the email notification preferences from access_email_notification_settings and cannot change their own.
`access_email_notification_settings`	object	Default email notification preferences applied to users with this role (which events trigger an email and through which channel).
`access_entity_account`	integer	Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_account_copy`	boolean	Allows users with this role to create copies of existing accounts.
`access_entity_account_delete`	boolean	Allows users with this role to delete accounts they can edit.
`access_entity_account_direction`	integer	Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_account_private`	boolean	Allows users with this role to own private accounts, which are visible only to their owner.
`access_entity_account_tag_create`	boolean	Allows users with this role to create new tags for accounts.
`access_entity_account_types`	integer	Whether users with this role can work with all account types (All) or only with those in allowed_account_types (Selected).1 All · 2 Selected
`access_entity_appointment`	integer	Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_appointment_delete`	boolean	Allows users with this role to delete appointments they can edit.
`access_entity_appointment_direction`	integer	Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_appointment_tag_create`	boolean	Allows users with this role to create new tags for appointments.
`access_entity_appointment_types`	integer	Whether users with this role can work with all appointment types (All) or only with those in allowed_appointment_types (Selected).1 All · 2 Selected
`access_entity_better_navigator`	integer	Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating …0 NoAccess · 1 Readonly · 4 All
`access_entity_better_navigator_delete_not_owned`	boolean	Allows users with this role to delete Navigator screen layouts owned by other users.
`access_entity_better_navigator_delete_owned`	boolean	Allows users with this role to delete Navigator screen layouts they own.
`access_entity_better_navigator_sharing_custom`	boolean	Allows users with this role to share their Navigator screen layouts with selected users and sales units.
`access_entity_better_navigator_sharing_public`	boolean	Allows users with this role to share their Navigator screen layouts with all users of the space.
`access_entity_contact`	integer	Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_contact_copy`	boolean	Allows users with this role to create copies of existing contacts.
`access_entity_contact_delete`	boolean	Allows users with this role to delete contacts they can edit.
`access_entity_contact_direction`	integer	Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_contact_private`	boolean	Allows users with this role to own private contacts, which are visible only to their owner.
`access_entity_contact_tag_create`	boolean	Allows users with this role to create new tags for contacts.
`access_entity_contact_types`	integer	Whether users with this role can work with all contact types (All) or only with those in allowed_contact_types (Selected).1 All · 2 Selected
`access_entity_dashboard`	integer	Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).0 NoAccess · 1 Readonly · 4 All
`access_entity_dashboard_delete_not_owned`	boolean	Allows users with this role to delete dashboards owned by other users.
`access_entity_dashboard_delete_owned`	boolean	Allows users with this role to delete dashboards they own.
`access_entity_dashboard_sharing_custom`	boolean	Allows users with this role to share their dashboards with selected users and sales units.
`access_entity_dashboard_sharing_public`	boolean	Allows users with this role to share their dashboards with all users of the space.
`access_entity_email_access_level`	integer	Which emails users with this role see on records, reports, feeds and automation.0 Default · 1 UsersAndSalesUnits
`access_entity_email_allowed`	object	Allow-list for access_entity_email_access_level = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible.
`access_entity_email_content_share_mode`	integer	How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).0 PrivateOnly · 1 Custom · 2 PublicOnly
`access_entity_email_delete_not_owned`	boolean	Allows users with this role to delete emails they neither own nor sent.
`access_entity_email_link_to_accounts`	integer	Whether the email integration of users with this role links emails to the accounts of their recipients.0 Custom · 1 On · 2 Off
`access_entity_email_link_to_accounts_by_domain`	integer	Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain.0 Custom · 1 On · 2 Off
`access_entity_email_link_to_contacts`	integer	Whether the email integration of users with this role links emails to the contacts of their recipients.0 Custom · 1 On · 2 Off
`access_entity_email_sequence`	integer	Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all …1 FullAccess · 2 Personal · 3 NoAccess
`access_entity_email_template`	integer	Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own …0 NoAccess · 1 Readonly · 4 All
`access_entity_email_template_create_delete_folder`	boolean	Allows users with this role to create and delete email template folders.
`access_entity_email_template_delete_not_owned`	boolean	Allows users with this role to delete email templates owned by other users.
`access_entity_email_template_delete_owned`	boolean	Allows users with this role to delete email templates they own.
`access_entity_email_template_sharing_custom`	boolean	Allows users with this role to share their email templates with selected users and sales units.
`access_entity_email_template_sharing_public`	boolean	Allows users with this role to share their email templates with all users of the space.
`access_entity_forecast`	integer	Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).0 NoAccess · 1 Readonly · 4 All
`access_entity_forecast_delete_not_owned`	boolean	Allows users with this role to delete forecasts owned by other users.
`access_entity_forecast_delete_owned`	boolean	Allows users with this role to delete forecasts they own.
`access_entity_forecast_edit_not_owned`	boolean	Allows users with this role to edit forecasts owned by other users.
`access_entity_forecast_sharing_custom`	boolean	Allows users with this role to share their forecasts with selected users and sales units.
`access_entity_forecast_sharing_public`	boolean	Allows users with this role to share their forecasts with all users of the space.
`access_entity_form_view`	integer	Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).0 NoAccess · 1 Readonly · 4 All
`access_entity_form_view_delete_not_owned`	boolean	Allows users with this role to delete form views owned by other users.
`access_entity_form_view_delete_owned`	boolean	Allows users with this role to delete form views they own.
`access_entity_form_view_sharing_custom`	boolean	Allows users with this role to share their form views with selected users and sales units.
`access_entity_form_view_sharing_public`	boolean	Allows users with this role to share their form views with all users of the space.
`access_entity_lead`	integer	Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_lead_copy`	boolean	Allows users with this role to create copies of existing leads.
`access_entity_lead_delete`	boolean	Allows users with this role to delete leads they can edit.
`access_entity_lead_direction`	integer	Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_lead_private`	boolean	Allows users with this role to own private leads, which are visible only to their owner.
`access_entity_lead_tag_create`	boolean	Allows users with this role to create new tags for leads.
`access_entity_lead_types`	integer	Whether users with this role can work with all lead types (All) or only with those in allowed_lead_types (Selected).1 All · 2 Selected
`access_entity_message_tag_create`	boolean	Allows users with this role to create new tags for emails, memos and text messages.
`access_entity_oppty`	integer	Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_oppty_copy`	boolean	Allows users with this role to create copies of existing opportunities.
`access_entity_oppty_delete`	boolean	Allows users with this role to delete opportunities they can edit.
`access_entity_oppty_direction`	integer	Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_oppty_private`	boolean	Allows users with this role to own private opportunities, which are visible only to their owner.
`access_entity_oppty_tag_create`	boolean	Allows users with this role to create new tags for opportunities.
`access_entity_pipeline`	integer	Which pipelines users with this role can work with: none (NoPipeline), those in allowed_pipelines (Selected), or all with or without access to pipeline step …0 NoPipeline · 1 Selected · 2 AllNoDocuments · 3 AllWithDocuments
`access_entity_process`	integer	Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) …1 FullAccess · 2 Personal · 3 NoAccess
`access_entity_profile`	integer	Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All).0 NoAccess · 1 Readonly · 4 All
`access_entity_profile_default_screen_profiles`	object	Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
`access_entity_profile_delete_not_owned`	boolean	Allows users with this role to delete screen profiles owned by other users.
`access_entity_profile_delete_owned`	boolean	Allows users with this role to delete screen profiles they own.
`access_entity_profile_sharing_custom`	boolean	Allows users with this role to share their screen profiles with selected users and sales units.
`access_entity_profile_sharing_public`	boolean	Allows users with this role to share their screen profiles with all users of the space.
`access_entity_project`	integer	Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_project_copy`	boolean	Allows users with this role to create copies of existing projects.
`access_entity_project_delete`	boolean	Allows users with this role to delete projects they can edit.
`access_entity_project_direction`	integer	Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_project_private`	boolean	Allows users with this role to own private projects, which are visible only to their owner.
`access_entity_project_tag_create`	boolean	Allows users with this role to create new tags for projects.
`access_entity_quote`	integer	Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_quote_copy`	boolean	Allows users with this role to create copies of existing quotes.
`access_entity_quote_delete`	boolean	Allows users with this role to delete quotes they can edit.
`access_entity_quote_direction`	integer	Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_quote_tag_create`	boolean	Allows users with this role to create new tags for quotes.
`access_entity_quote_types`	integer	Whether users with this role can work with all quote types (All) or only with those in allowed_quote_types (Selected).1 All · 2 Selected
`access_entity_report`	integer	Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).0 NoAccess · 1 Readonly · 4 All
`access_entity_report_create_delete_folder`	boolean	Allows users with this role to create and delete report folders.
`access_entity_report_delete_not_owned`	boolean	Allows users with this role to delete reports owned by other users.
`access_entity_report_delete_owned`	boolean	Allows users with this role to delete reports they own.
`access_entity_report_private`	boolean	Allows users with this role to save reports as private, visible only to themselves.
`access_entity_report_schedule_create`	boolean	Allows users with this role to schedule reports for regular delivery.
`access_entity_report_schedule_management`	boolean	Allows users with this role to view and manage report schedules of other users.
`access_entity_report_sharing_custom`	boolean	Allows users with this role to share their reports with selected users and sales units.
`access_entity_report_sharing_public`	boolean	Allows users with this role to share their reports with all users of the space.
`access_entity_solution`	boolean	Allows users with this role to view and follow solutions, when the feature is enabled for the space.
`access_entity_solution_management`	boolean	Allows users with this role to create, edit and delete solutions.
`access_entity_target`	integer	Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).0 NoAccess · 1 Readonly · 4 All
`access_entity_target_delete_not_owned`	boolean	Allows users with this role to delete targets owned by other users.
`access_entity_target_delete_owned`	boolean	Allows users with this role to delete targets they own.
`access_entity_task`	integer	Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All.0 NoAccess · 1 Readonly · 2 Editor · 3 EditorOrUnitManger · 4 All
`access_entity_task_delete`	boolean	Allows users with this role to delete tasks they can edit.
`access_entity_task_direction`	integer	Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its …1 Owned · 2 Current · 3 CurrentAndParent · 4 CurrentAndSubunit · 5 CurrentAndParentAndSubunit · 6 All
`access_entity_task_tag_create`	boolean	Allows users with this role to create new tags for tasks.
`access_entity_task_types`	integer	Whether users with this role can work with all task types (All) or only with those in allowed_task_types (Selected).1 All · 2 Selected
`access_entity_task_unassigned`	boolean	Allows users with this role to create tasks without an owner (unassigned tasks).
`access_export`	boolean	Allows users with this role to export records and reports to files.
`access_feeds`	boolean	Allows users with this role to open the Feed screen with the stream of activities, emails and other updates.
`access_foreign_currencies`	boolean	Allows users with this role to manage currencies and exchange rate lists in Administration.
`access_form_and_fields`	boolean	Allows users with this role to manage fields, forms, record types, tags and translations in Administration.
`access_global_settings`	boolean	Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
`access_home_screen`	boolean	Allows users with this role to open the Navigator screen.
`access_import`	boolean	Allows users with this role to import records from files.
`access_insights`	boolean	Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
`access_leads`	boolean	Shows the Leads screen to users with this role.
`access_online_forms`	boolean	Allows users with this role to create online forms and manage their own, when online forms are enabled for the space.
`access_online_forms_management`	boolean	Allows users with this role to edit and delete online forms owned by other users.
`access_opportunity`	boolean	Shows the Opportunities screen to users with this role.
`access_pipeline_configuration`	boolean	Allows users with this role to manage pipelines, lead processes and quote processes in Administration.
`access_print`	boolean	Allows users with this role to print records and reports.
`access_products_services`	boolean	Allows users with this role to manage products, product categories and price lists in Administration.
`access_projects`	boolean	Allows users with this role to use Projects, when the feature is enabled for the space.
`access_quotes`	boolean	Allows users with this role to use Quotes, when the feature is enabled for the space.
`access_sales_roles`	boolean	Allows users with this role to manage sales roles in Administration.
`access_security`	boolean	Allows users with this role to manage the security settings of the space in Administration.
`access_units`	boolean	Allows users with this role to manage sales units in Administration.
`access_user_and_roles`	boolean	Allows users with this role to manage users, user roles and sales unit membership in Administration.
`access_whats_app_company_phone`	integer	Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in …0 NoAccess · 1 Selected · 2 All
`bottom_menu_layout`	object	The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, …
`revision`	integer	Revision when entity was lastly changed.
`allowed_pipelines`	array of uri → AllowedPipelines	Pipelines this user role can use.
`allowed_lead_types`	array of uri → AllowedLeadTypes	Lead types this user role can use.
`allowed_quote_types`	array of uri → AllowedQuoteTypes	Quote types this user role can use.
`allowed_account_types`	array of uri → AllowedAccountTypes	Account types this user role can use.
`allowed_contact_types`	array of uri → AllowedContactTypes	Contact types this user role can use.
`allowed_task_types`	array of uri → AllowedTaskTypes	Task types this user role can use.
`allowed_appointment_types`	array of uri → AllowedAppointmentTypes	Appointment types this user role can use.
`allowed_company_emails`	array of uri → AllowedCompanyEmails	Company email addresses this user role can send from.
`allowed_company_phones`	array of uri → AllowedCompanyPhones	Company phones this user role can use for calling/SMS.
`custom_entities`	binary	Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role.
`is_delete_protected`	boolean	Read-only True when the record is protected against deletion because it must always exist in the space.
`is_deleted`	boolean	Read-only Specifies if the entity is considered deleted.
`modified`	date-time	Read-only Last modification time.
`created`	date-time	Read-only Creation time.

Custom fields appear in your space's live spec: fetch it with your credentials.

Errors

Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.

HTTP	When
400	Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
401	Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404	No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
422	Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
429	Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500	Unexpected server error (code 1000, ERROR_UNKNOWN).