API Documentation

API Endpoint

Service Types

Service Types

GET /api/v2/service_types
Requestsreturns service types

GET  /api/v2/service_types

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1163",
      "type": "service_types",
      "attributes": {
        "name": "test service type",
        "archived_at": null,
        "description": "test description"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1847"
          }
        },
        "assignees": {
          "data": []
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/service_types?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/service_types?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get service types
GET/api/v2/service_types


GET /api/v2/service_types/1
Requestsreturns service type

GET  /api/v2/service_types/1164

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1164",
    "type": "service_types",
    "attributes": {
      "name": "test service type",
      "archived_at": null,
      "description": "test description"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1848"
        }
      },
      "assignees": {
        "data": []
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets a service type
GET/api/v2/service_types/{id}

URI Parameters
HideShow
id
number (required) Example: 1

service type id


POST /api/v2/service_types
Requestscreates service typereturns error

POST  /api/v2/service_types

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+json
Body
{
  "data": {
    "type": "service_types",
    "attributes": {
      "name": "test name"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1166",
    "type": "service_types",
    "attributes": {
      "name": "test name",
      "archived_at": null,
      "description": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1849"
        }
      },
      "assignees": {
        "data": []
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/service_types

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+json
Body
{
  "data": {
    "type": "service_types",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Create a service type
POST/api/v2/service_types

URI Parameters
HideShow
name
string (required) Example: Name

name


PATCH /api/v2/service_types/1
Requestsupdates service_typereturns error

PATCH  /api/v2/service_types/1168

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+json
Body
{
  "data": {
    "type": "service_types",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1168",
    "type": "service_types",
    "attributes": {
      "name": "new name",
      "archived_at": null,
      "description": "test description"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1851"
        }
      },
      "assignees": {
        "data": []
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/service_types/1169

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+json
Body
{
  "data": {
    "type": "service_types",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update a service type
PATCH/api/v2/service_types/{id}

URI Parameters
HideShow
id
number (required) Example: 1

service type id


PATCH /api/v2/service_types/1/archive
Requestsarchives service_type

PATCH  /api/v2/service_types/1170/archive

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+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1170",
    "type": "service_types",
    "attributes": {
      "name": "test service type",
      "archived_at": "2024-03-28T05:15:26.000+01:00",
      "description": "test description"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1853"
        }
      },
      "assignees": {
        "data": []
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Archives a service type
PATCH/api/v2/service_types/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

service type id


DELETE /api/v2/service_types/1
Requestsdeletes service type

DELETE  /api/v2/service_types/1175

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+json
Responses204
This response has no content.

Deletes a service type
DELETE/api/v2/service_types/{id}

URI Parameters
HideShow
id
number (required) Example: 1

service type id


Generated by aglio on 28 Mar 2024