Jump to Content

Home Documentation API Reference Discussions

API Reference

Home Documentation API Reference Discussions

Getting Started

Using Try It!
Logging in

Vitruvi API Documentation

Aggregation
Async events
Global Configuration
Conditional custom field overrides
Configuration library
Content types
- List Content Typesget
Crew categories
Crews
Crews with resources
Custom field categories
Custom field settings
Custom field settings by entity
- /api/v1/custom_field_settings_by_entityget
Custom fields
Data resource
Design element categories
Engineering
Entity file folders
Entity files
Equipment
Equipment categories
Exports
- /api/v1/exports/grid/post
Global settings
Grid views
Inbox
- /api/v1/inbox/feature_batches/mark_processedpost
- /api/v1/inbox/feature_batches/to_processget
Infrastructure categories
Integrations
- /api/v1/integrations/{integration_name}get
- /api/v1/integrations/{integration_name}post
Invoicing
Jobs
- Get Job Statusget
Labor items
Material categories
Material quantity descriptions
Mobile
Monitoring
Network calculus
- /api/v1/network_calculus/external_integrationget
- /api/v1/network_calculus/external_integrationpost
Network operator
Network operators
Payable item categories
Permissions tree view
- /api/v1/permissions_tree_view/{permission_for}/{permission_type}get
- /api/v1/permissions_tree_view/{permission_for}/{permission_type}post
Permissions tree view compacted
- /api/v1/permissions_tree_view_compacted/{permission_for}/{permission_type}get
- /api/v1/permissions_tree_view_compacted/{permission_for}/{permission_type}post
Premise categories
Presigned urls
- /api/v1/presigned_urls/get
Production
Qualifications
Quantity descriptions
Reporting
Revision changesets
- /api/v1/revision_changesets/{id}/get
Roles
Safety
Scheduling
Settings
- /api/v1/settings/get
Subscribe
- /api/v1/subscribepost
Support utils
- /api/v1/support_utils/{command_name}post
Ticketing
Time keeping
Unique field check
- /api/v1/unique_field_check/{contentType}/get
Unit dimensions
Units
Unsubscribe
- /api/v1/unsubscribepost
User groups
User permissions
- List Permissionsget
- Retrieve Permissionget
User tiers
Users
Variables
Wbs
Work item categories
Work order categories
Auth

Powered by

Getting Started

Using Try It!
Logging in

Vitruvi API Documentation

Aggregation
Async events
Global Configuration
Conditional custom field overrides
Configuration library
Content types
- List Content Typesget
Crew categories
Crews
Crews with resources
Custom field categories
Custom field settings
Custom field settings by entity
- /api/v1/custom_field_settings_by_entityget
Custom fields
Data resource
Design element categories
Engineering
Entity file folders
Entity files
Equipment
Equipment categories
Exports
- /api/v1/exports/grid/post
Global settings
Grid views
Inbox
- /api/v1/inbox/feature_batches/mark_processedpost
- /api/v1/inbox/feature_batches/to_processget
Infrastructure categories
Integrations
- /api/v1/integrations/{integration_name}get
- /api/v1/integrations/{integration_name}post
Invoicing
Jobs
- Get Job Statusget
Labor items
Material categories
Material quantity descriptions
Mobile
Monitoring
Network calculus
- /api/v1/network_calculus/external_integrationget
- /api/v1/network_calculus/external_integrationpost
Network operator
Network operators
Payable item categories
Permissions tree view
- /api/v1/permissions_tree_view/{permission_for}/{permission_type}get
- /api/v1/permissions_tree_view/{permission_for}/{permission_type}post
Permissions tree view compacted
- /api/v1/permissions_tree_view_compacted/{permission_for}/{permission_type}get
- /api/v1/permissions_tree_view_compacted/{permission_for}/{permission_type}post
Premise categories
Presigned urls
- /api/v1/presigned_urls/get
Production
Qualifications
Quantity descriptions
Reporting
Revision changesets
- /api/v1/revision_changesets/{id}/get
Roles
Safety
Scheduling
Settings
- /api/v1/settings/get
Subscribe
- /api/v1/subscribepost
Support utils
- /api/v1/support_utils/{command_name}post
Ticketing
Time keeping
Unique field check
- /api/v1/unique_field_check/{contentType}/get
Unit dimensions
Units
Unsubscribe
- /api/v1/unsubscribepost
User groups
User permissions
- List Permissionsget
- Retrieve Permissionget
User tiers
Users
Variables
Wbs
Work item categories
Work order categories
Auth

Powered by

List Roles

get https://example.com/api/v1/roles/

Returns a list of all roles.

Language

Credentials

:

Click Try It! to start a request and see the response here!