API Documentation
Widgets ¶
GET /api/v2/widgets
Requests
GET /api/v2/widgets
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "1",
"type": "widgets",
"attributes": {
"widget_type_id": 1,
"default_filter_id": null,
"width": 2,
"height": 2,
"row_position": 0,
"column_position": 0,
"report_layout_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1308
}
},
"dashboard": {
"data": {
"type": "dashboards",
"id": "19"
}
}
}
},
{
"id": "2",
"type": "widgets",
"attributes": {
"widget_type_id": 1,
"default_filter_id": null,
"width": 2,
"height": 2,
"row_position": 0,
"column_position": 0,
"report_layout_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1308
}
},
"dashboard": {
"data": {
"type": "dashboards",
"id": "19"
}
}
}
},
{
"id": "3",
"type": "widgets",
"attributes": {
"widget_type_id": 1,
"default_filter_id": null,
"width": 2,
"height": 2,
"row_position": 0,
"column_position": 0,
"report_layout_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1308
}
},
"dashboard": {
"data": {
"type": "dashboards",
"id": "19"
}
}
}
}
],
"included": [
{
"id": "19",
"type": "dashboards",
"attributes": {
"name": "dashboard_name"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1308
}
},
"person": {
"data": {
"type": "people",
"id": "4756"
}
}
}
},
{
"id": "4756",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4698@email.com",
"title": null,
"joined_at": "2021-01-24T00:09:34.000+01:00",
"last_seen_at": "2021-01-24T00:09:34.309+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:09:34.260+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1308
}
},
"company": {
"data": {
"type": "companies",
"id": "7142"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "7142",
"type": "companies",
"attributes": {
"name": "Organization1308",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:09:34.259+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1308
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/widgets?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/widgets?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 3,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get all widgetsGET/api/v2/widgets
GET /api/v2/widgets/4
Requests
GET /api/v2/widgets/4
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "widgets",
"attributes": {
"widget_type_id": 1,
"default_filter_id": null,
"width": 2,
"height": 2,
"row_position": 0,
"column_position": 0,
"report_layout_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1309
}
},
"dashboard": {
"data": {
"type": "dashboards",
"id": "20"
}
}
}
},
"included": [
{
"id": "20",
"type": "dashboards",
"attributes": {
"name": "dashboard_name"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1309
}
},
"person": {
"data": {
"type": "people",
"id": "4757"
}
}
}
},
{
"id": "4757",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4699@email.com",
"title": null,
"joined_at": "2021-01-24T00:09:34.000+01:00",
"last_seen_at": "2021-01-24T00:09:34.402+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:09:34.366+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1309
}
},
"company": {
"data": {
"type": "companies",
"id": "7143"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "7143",
"type": "companies",
"attributes": {
"name": "Organization1309",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:09:34.365+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1309
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/widgets
Requests
POST /api/v2/widgets
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": "widgets",
"attributes": {
"width": 2,
"height": 2,
"row_position": 2,
"column_position": 2,
"widget_type_id": 1
},
"relationships": {
"dashboard": {
"data": {
"type": "dashboards",
"id": "21"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "6",
"type": "widgets",
"attributes": {
"widget_type_id": 1,
"default_filter_id": null,
"width": 2,
"height": 2,
"row_position": 2,
"column_position": 2,
"report_layout_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1310
}
},
"dashboard": {
"data": {
"type": "dashboards",
"id": "21"
}
}
}
},
"included": [
{
"id": "21",
"type": "dashboards",
"attributes": {
"name": "dashboard_name"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1310
}
},
"person": {
"data": {
"type": "people",
"id": "4758"
}
}
}
},
{
"id": "4758",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4700@email.com",
"title": null,
"joined_at": "2021-01-24T00:09:34.000+01:00",
"last_seen_at": "2021-01-24T00:09:34.491+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:09:34.456+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1310
}
},
"company": {
"data": {
"type": "companies",
"id": "7144"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "7144",
"type": "companies",
"attributes": {
"name": "Organization1310",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:09:34.455+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1310
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/widgets
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": "widgets",
"attributes": {
"width": 2,
"height": 2,
"row_position": 2,
"column_position": 2,
"widget_type_id": 1
},
"relationships": {
"dashboard": {
"data": {
"type": "dashboards",
"id": "0"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/dashboard"
}
}
]
}
POST /api/v2/widgets
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
{
"type": "widgets",
"attributes": {
"width": "",
"height": ""
}
}
Responses
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/height"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a number",
"source": {
"pointer": "data/attributes/height"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/width"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a number",
"source": {
"pointer": "data/attributes/width"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/widget_type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/dashboard"
}
}
]
}
Create a widgetPOST/api/v2/widgets
URI Parameters
- column
number
(required) Example: 1column
- row
number
(required) Example: 1row
- height
number
(required) Example: 1height
- width
number
(required) Example: 1width
- widget_type_id
number
(required) Example: 1widget type id
- dashboard_id
number
(required) Example: 1dashboard id
PATCH /api/v2/widgets/1
Requests
PATCH /api/v2/widgets/9
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": "widgets",
"attributes": {
"row_position": 5
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "9",
"type": "widgets",
"attributes": {
"widget_type_id": 1,
"default_filter_id": null,
"width": 2,
"height": 2,
"row_position": 5,
"column_position": 0,
"report_layout_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1313
}
},
"dashboard": {
"data": {
"type": "dashboards",
"id": "24"
}
}
}
},
"included": [
{
"id": "24",
"type": "dashboards",
"attributes": {
"name": "dashboard_name"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1313
}
},
"person": {
"data": {
"type": "people",
"id": "4761"
}
}
}
},
{
"id": "4761",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user4703@email.com",
"title": null,
"joined_at": "2021-01-24T00:09:34.000+01:00",
"last_seen_at": "2021-01-24T00:09:34.758+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:09:34.721+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1313
}
},
"company": {
"data": {
"type": "companies",
"id": "7147"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "7147",
"type": "companies",
"attributes": {
"name": "Organization1313",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:09:34.719+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1313
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"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
},
"duplicate_tasks": {
"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
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/widgets/10
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": "widgets",
"attributes": {
"row_position": ""
}
}
}
Responses
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/row_position"
}
}
]
}
DELETE /api/v2/widgets/1
Requests
DELETE /api/v2/widgets/11
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
Responses
This response has no content.
Generated by aglio on 23 Jan 2021