API Documentation
Permission Sets ¶
Permission Sets ¶
The Permission Set object represents a set of permissions that can be assigned to a user.
You can find out more about permission sets in our Help documentation: Permission Sets
GET /api/v2/roles
Requests
GET /api/v2/roles
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": [
{
"id": "7508",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": true,
"bank_accounts_manage": true,
"billables_view": true,
"budgets_view_restricted": true,
"budgets_view_all": true,
"budgets_manage": true,
"budgets_share": true,
"budgets_scenarios_view": true,
"budgets_scenarios_manage": true,
"budgets_scenarios_apply": true,
"companies_view": true,
"companies_manage": true,
"contacts_view": true,
"contacts_manage": true,
"team_members_contact_info_view": true,
"cost_rates_view": true,
"cost_rates_view_inside_subsidiary": true,
"cost_rates_manage": true,
"cost_rates_view_for_subordinates": true,
"custom_fields_manage": true,
"task_custom_fields_manage": true,
"doc_custom_fields_manage": true,
"deals_view_restricted": true,
"deals_view_all": true,
"deals_manage": true,
"deals_share": true,
"deals_scenarios_view": true,
"deals_scenarios_manage": true,
"deals_scenarios_apply": true,
"deals_proposals_delete_signed": true,
"deals_funnel_reports_view": true,
"document_types_and_styles_manage": true,
"docs_manage": true,
"docs_view": true,
"emails_manage": true,
"entitlements_view_self": true,
"entitlements_view_all": true,
"entitlements_manage": true,
"entitlements_view_inside_subsidiary": true,
"events_view": true,
"events_manage": true,
"expenses_view_self": true,
"expenses_view_all": true,
"expenses_view_restricted": true,
"expenses_manage_self": true,
"expenses_manage": true,
"expenses_approve_where_deal_owner": true,
"expenses_approve_restricted": true,
"expenses_approve_all": true,
"financials_locking_manage": true,
"financial_item_reports_view": true,
"holidays_manage": true,
"imports_manage": true,
"integrations_manage_organizational": true,
"integrations_manage_personal": true,
"integrations_manage_task_management": true,
"integrations_view_task_management": true,
"invoices_view_restricted": true,
"invoices_view_all": true,
"invoices_manage_draft": true,
"invoices_manage_finalized": true,
"invoices_limited_manage_finalized": true,
"invoices_copy_to_accounting": true,
"invoices_manage_intercompany": true,
"invoices_send_to_client": true,
"organization_administrate": true,
"organization_polaris_access": true,
"overheads_manage": true,
"payments_view": true,
"payments_manage": true,
"payment_reminders_manage": true,
"payment_reminder_sequences_manage": true,
"placeholders_view": true,
"placeholders_manage": true,
"profitability_view": true,
"projects_view_restricted": true,
"projects_view_all": true,
"projects_manage": true,
"boards_manage": true,
"task_lists_manage": true,
"purchase_orders_view_restricted": true,
"purchase_orders_manage": true,
"resource_requests_view": true,
"resource_requests_create": true,
"resource_requests_resolve": true,
"rate_cards_view": true,
"rate_cards_manage": true,
"report_categories_manage": true,
"insights_view": true,
"insights_manage": true,
"roles_view": true,
"roles_manage": true,
"sales_manage": true,
"service_bookings_view_self": true,
"service_bookings_view_restricted": true,
"service_bookings_view_all": true,
"service_bookings_manage": true,
"service_bookings_view_tentative": true,
"service_types_view": true,
"service_types_manage": true,
"subscription_manage_billing": true,
"subscription_manage_seats": true,
"subscription_manage": true,
"surveys_manage": true,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": true,
"teams_view": true,
"teams_manage": true,
"time_entries_view_all": true,
"time_entries_view_restricted": true,
"time_entries_manage": true,
"time_entries_manage_self": true,
"time_entries_manage_locked": true,
"time_entries_approve_restricted": true,
"time_entries_approve_where_user_is_approver": true,
"time_entries_approve_all": true,
"time_off_bookings_view_all": true,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": true,
"time_off_bookings_approve_all": true,
"time_off_bookings_approve_restricted": true,
"time_off_bookings_view_note": true,
"time_off_bookings_view_inside_subsidiary": true,
"time_reports_view_self": true,
"time_reports_view_all": true,
"time_tracking_policies_manage": true,
"team_members_and_roles_view": true,
"team_members_manage": true,
"team_members_roles_manage": true,
"clients_view": true,
"clients_manage": true,
"contacts_custom_field_values_view": true,
"contacts_custom_field_values_manage": true,
"contacts_sensitive_custom_field_values_view": true,
"contacts_sensitive_custom_field_values_manage": true,
"employees_field_values_view": true,
"employees_field_values_manage": true,
"employees_sensitive_custom_field_values_view": true,
"employees_sensitive_custom_field_values_manage": true,
"clients_deactivation_and_offboarding_manage": true,
"team_members_deactivation_and_offboarding_manage": true,
"webhooks_manage_webhooks": true,
"webhooks_manage_own_zapier_triggers": true,
"workflows_manage": true,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1862"
}
}
}
},
{
"id": "7509",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 0,
"permissions": {},
"editable_by_user": true,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1862"
}
}
}
},
{
"id": "7510",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 0,
"permissions": {},
"editable_by_user": true,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1862"
}
}
}
},
{
"id": "7511",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 0,
"permissions": {},
"editable_by_user": true,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1862"
}
}
}
},
{
"id": "7512",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 0,
"permissions": {},
"editable_by_user": true,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1862"
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/roles?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/roles?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 5,
"page_size": 30,
"max_page_size": 200
}
}Get permission setsGET/api/v2/roles
GET /api/v2/roles/1
Requests
GET /api/v2/roles/7514
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+jsonResponses
Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": "7514",
"type": "roles",
"attributes": {
"base_role_id": 3,
"description": "test description",
"name": "test_role",
"people_count": 0,
"permissions": {},
"editable_by_user": true,
"user_type_id": 1,
"resolved_permissions": {
"allocations_view": false,
"automations_manage": false,
"bank_accounts_manage": false,
"billables_view": false,
"budgets_view_restricted": false,
"budgets_view_all": false,
"budgets_manage": false,
"budgets_share": false,
"budgets_scenarios_view": false,
"budgets_scenarios_manage": false,
"budgets_scenarios_apply": false,
"companies_view": false,
"companies_manage": false,
"contacts_view": false,
"contacts_manage": false,
"team_members_contact_info_view": true,
"cost_rates_view": false,
"cost_rates_view_inside_subsidiary": false,
"cost_rates_manage": false,
"cost_rates_view_for_subordinates": false,
"custom_fields_manage": false,
"task_custom_fields_manage": false,
"doc_custom_fields_manage": false,
"deals_view_restricted": false,
"deals_view_all": false,
"deals_manage": false,
"deals_share": false,
"deals_scenarios_view": false,
"deals_scenarios_manage": false,
"deals_scenarios_apply": false,
"deals_proposals_delete_signed": false,
"deals_funnel_reports_view": false,
"document_types_and_styles_manage": false,
"docs_manage": true,
"docs_view": true,
"emails_manage": false,
"entitlements_view_self": true,
"entitlements_view_all": false,
"entitlements_manage": false,
"entitlements_view_inside_subsidiary": false,
"events_view": true,
"events_manage": false,
"expenses_view_self": true,
"expenses_view_all": false,
"expenses_view_restricted": false,
"expenses_manage_self": true,
"expenses_manage": false,
"expenses_approve_where_deal_owner": false,
"expenses_approve_restricted": false,
"expenses_approve_all": false,
"financials_locking_manage": false,
"financial_item_reports_view": false,
"holidays_manage": false,
"imports_manage": false,
"integrations_manage_organizational": false,
"integrations_manage_personal": true,
"integrations_manage_task_management": false,
"integrations_view_task_management": true,
"invoices_view_restricted": false,
"invoices_view_all": false,
"invoices_manage_draft": false,
"invoices_manage_finalized": false,
"invoices_limited_manage_finalized": false,
"invoices_copy_to_accounting": false,
"invoices_manage_intercompany": false,
"invoices_send_to_client": false,
"organization_administrate": false,
"organization_polaris_access": false,
"overheads_manage": false,
"payments_view": false,
"payments_manage": false,
"payment_reminders_manage": false,
"payment_reminder_sequences_manage": false,
"placeholders_view": false,
"placeholders_manage": false,
"profitability_view": false,
"projects_view_restricted": true,
"projects_view_all": false,
"projects_manage": false,
"boards_manage": false,
"task_lists_manage": true,
"purchase_orders_view_restricted": false,
"purchase_orders_manage": false,
"resource_requests_view": false,
"resource_requests_create": false,
"resource_requests_resolve": false,
"rate_cards_view": false,
"rate_cards_manage": false,
"report_categories_manage": false,
"insights_view": false,
"insights_manage": false,
"roles_view": false,
"roles_manage": false,
"sales_manage": false,
"service_bookings_view_self": true,
"service_bookings_view_restricted": false,
"service_bookings_view_all": false,
"service_bookings_manage": false,
"service_bookings_view_tentative": false,
"service_types_view": true,
"service_types_manage": false,
"subscription_manage_billing": false,
"subscription_manage_seats": false,
"subscription_manage": false,
"surveys_manage": false,
"tasks_view": true,
"tasks_manage": true,
"tax_rates_manage": false,
"teams_view": true,
"teams_manage": false,
"time_entries_view_all": false,
"time_entries_view_restricted": false,
"time_entries_manage": false,
"time_entries_manage_self": true,
"time_entries_manage_locked": false,
"time_entries_approve_restricted": false,
"time_entries_approve_where_user_is_approver": false,
"time_entries_approve_all": false,
"time_off_bookings_view_all": false,
"time_off_bookings_manage_self": true,
"time_off_bookings_manage_all": false,
"time_off_bookings_approve_all": false,
"time_off_bookings_approve_restricted": false,
"time_off_bookings_view_note": false,
"time_off_bookings_view_inside_subsidiary": false,
"time_reports_view_self": true,
"time_reports_view_all": false,
"time_tracking_policies_manage": false,
"team_members_and_roles_view": false,
"team_members_manage": false,
"team_members_roles_manage": false,
"clients_view": false,
"clients_manage": false,
"contacts_custom_field_values_view": false,
"contacts_custom_field_values_manage": false,
"contacts_sensitive_custom_field_values_view": false,
"contacts_sensitive_custom_field_values_manage": false,
"employees_field_values_view": true,
"employees_field_values_manage": false,
"employees_sensitive_custom_field_values_view": false,
"employees_sensitive_custom_field_values_manage": false,
"clients_deactivation_and_offboarding_manage": false,
"team_members_deactivation_and_offboarding_manage": false,
"webhooks_manage_webhooks": false,
"webhooks_manage_own_zapier_triggers": false,
"workflows_manage": false,
"workload_items_view": true
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1863"
}
}
}
},
"meta": {}
}Generated by aglio on 26 Dec 2025