API Documentation
Holidays ¶
GET /api/v2/holidays
Requests
GET /api/v2/holidays
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": "18",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2021-01-24"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 311
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "19"
}
}
}
},
{
"id": "19",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2021-01-24"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 311
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "20"
}
}
}
},
{
"id": "20",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2021-01-24"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 311
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "21"
}
}
}
}
],
"included": [
{
"id": "19",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary19",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 311
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "20",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary20",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 311
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
},
{
"id": "21",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary21",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 311
}
},
"bill_from": {
"data": null
},
"integration": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/holidays?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/holidays?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 holidaysGET/api/v2/holidays
GET /api/v2/holidays/1
Requests
GET /api/v2/holidays/21
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": "21",
"type": "holidays",
"attributes": {
"name": "International Goof Off Day",
"date": "2021-01-24"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 312
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "23"
}
}
}
},
"included": [
{
"id": "23",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary23",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 312
}
},
"bill_from": {
"data": null
},
"integration": {
"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/holidays
Requests
POST /api/v2/holidays
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": "holidays",
"attributes": {
"name": "Dont Cry over Spilled Milk Day",
"date": "2017-02-11",
"subsidiary_id": 26
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "27",
"type": "holidays",
"attributes": {
"name": "Dont Cry over Spilled Milk Day",
"date": "2017-02-11"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 313
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "26"
}
}
}
},
"included": [
{
"id": "26",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary26",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 313
}
},
"bill_from": {
"data": null
},
"integration": {
"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/holidays
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": "holidays",
"attributes": {}
}
}
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/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/date"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/subsidiary"
}
}
]
}
Create a holidayPOST/api/v2/holidays
URI Parameters
- name
string
(required) Example: Namename
- date
date
(required) Example: 2018-01-01date
PATCH /api/v2/holidays/1
Requests
PATCH /api/v2/holidays/31
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": "holidays",
"attributes": {
"name": "Lame Duck Day",
"date": "2017-02-06"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "31",
"type": "holidays",
"attributes": {
"name": "Lame Duck Day",
"date": "2017-02-06"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 315
}
},
"subsidiary": {
"data": {
"type": "subsidiaries",
"id": "35"
}
}
}
},
"included": [
{
"id": "35",
"type": "subsidiaries",
"attributes": {
"name": "Subsidiary35",
"invoice_number_format": null,
"archived_at": null,
"export_integration_type_id": null,
"invoice_logo_url": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 315
}
},
"bill_from": {
"data": null
},
"integration": {
"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/holidays/34
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": "holidays",
"attributes": {
"name": null
}
}
}
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/name"
}
}
]
}
DELETE /api/v2/holidays/1
Requests
DELETE /api/v2/holidays/37
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