Skip to main content
GET
/
roles
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "team_id": 123,
    "name": "<string>",
    "position": 123,
    "admin": true,
    "external": true,
    "accounting": "edit",
    "accounting_and_invoices": "on",
    "add_and_manage_items": "on",
    "area_plans": "edit",
    "bi_dashboards": "edit",
    "budgeting": "edit",
    "contacts": "edit",
    "cross_project_saved_views": "edit",
    "dashboard_and_recycle_bin": "edit",
    "default_schedule_column_permission": "edit",
    "download_report": "on",
    "exchange_rates": "edit",
    "integrations": "edit",
    "library": "edit",
    "library_editor": "edit",
    "lock_unlock_items": "on",
    "moodboards": "edit",
    "procurement_account_settings": "edit",
    "procurement_approval_settings": "edit",
    "procurement_documents": "edit",
    "procurement_documents_settings": "edit",
    "procurement_payment_term_settings": "edit",
    "procurement_product_settings": "edit",
    "procurement_qbo_settings": "edit",
    "procurement_rfq_settings": "edit",
    "procurement_service_items_retainer_settings": "edit",
    "review_items": "on",
    "revisions": "on",
    "role_management": "edit",
    "sharing": "edit",
    "template_configuration": "edit",
    "upload_and_update_data": "on"
  }
]

Authorizations

​
authorization
string
header
required

Response

OK

​
id
integer
​
team_id
integer
​
name
string
​
position
integer
​
admin
boolean
​
external
boolean
​
accounting
enum<string>
Available options:
edit,
view,
no_access
​
accounting_and_invoices
enum<string>
Available options:
on,
off
​
add_and_manage_items
enum<string>
Available options:
on,
off
​
area_plans
enum<string>
Available options:
edit,
view,
no_access
​
bi_dashboards
enum<string>
Available options:
edit,
view,
no_access
​
budgeting
enum<string>
Available options:
edit,
view,
no_access
​
contacts
enum<string>
Available options:
edit,
view,
no_access
​
cross_project_saved_views
enum<string>
Available options:
edit,
view,
no_access
​
dashboard_and_recycle_bin
enum<string>
Available options:
edit,
view,
no_access
​
default_schedule_column_permission
enum<string>
Available options:
edit,
view,
no_access
​
download_report
enum<string>
Available options:
on,
off
​
exchange_rates
enum<string>
Available options:
edit,
view,
no_access
​
integrations
enum<string>
Available options:
edit,
view,
no_access
​
library
enum<string>
Available options:
edit,
view,
no_access
​
library_editor
enum<string>
Available options:
edit,
view,
no_access
​
lock_unlock_items
enum<string>
Available options:
on,
off
​
moodboards
enum<string>
Available options:
edit,
view,
no_access
​
procurement_account_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_approval_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_documents
enum<string>
Available options:
edit,
view,
no_access
​
procurement_documents_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_payment_term_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_product_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_qbo_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_rfq_settings
enum<string>
Available options:
edit,
view,
no_access
​
procurement_service_items_retainer_settings
enum<string>
Available options:
edit,
view,
no_access
​
review_items
enum<string>
Available options:
on,
off
​
revisions
enum<string>
Available options:
on,
off
​
role_management
enum<string>
Available options:
edit,
view,
no_access
​
sharing
enum<string>
Available options:
edit,
view,
no_access
​
template_configuration
enum<string>
Available options:
edit,
view,
no_access
​
upload_and_update_data
enum<string>
Available options:
on,
off