API Documentation
Custom Fields ¶
Custom Fields ¶
GET /api/v2/custom_fields
Requests
GET /api/v2/custom_fields
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": "7",
"type": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 178
}
},
"project": {
"data": null
},
"options": {
"data": []
}
}
},
{
"id": "8",
"type": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 178
}
},
"project": {
"data": null
},
"options": {
"data": []
}
}
},
{
"id": "9",
"type": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 178
}
},
"project": {
"data": null
},
"options": {
"data": []
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/custom_fields?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/custom_fields?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": 3
},
"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 custom fieldsGET/api/v2/custom_fields
GET /api/v2/custom_fields/1
Requests
GET /api/v2/custom_fields/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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "10",
"type": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 179
}
},
"project": {
"data": null
},
"options": {
"data": []
}
}
},
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 1
},
"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": {}
}
}
Gets a custom fieldGET/api/v2/custom_fields/{id}
URI Parameters
- id
number
(required) Example: 1custom field id
POST /api/v2/custom_fields
Requests
POST /api/v2/custom_fields
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": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 1,
"customizable_type": "deals"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "12",
"type": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 180
}
},
"project": {
"data": null
},
"options": {
"data": []
}
}
},
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 2
},
"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/custom_fields
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": "custom_fields",
"attributes": {
"data_type_id": 1,
"customizable_type": "deals"
}
}
}
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"
}
}
]
}
Creates a custom fieldPOST/api/v2/custom_fields
URI Parameters
- id
number
(required) Example: 1custom field id
PATCH /api/v2/custom_fields/1
Requests
PATCH /api/v2/custom_fields/14
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": "custom_fields",
"attributes": {
"name": "Team"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "14",
"type": "custom_fields",
"attributes": {
"name": "Team",
"data_type_id": 1,
"required": false,
"description": null,
"archived_at": null,
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 182
}
},
"project": {
"data": null
},
"options": {
"data": []
}
}
},
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 1
},
"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": {}
}
}
Updates a custom fieldPATCH/api/v2/custom_fields/{id}
URI Parameters
- id
number
(required) Example: 1custom field id
PATCH /api/v2/custom_fields/1/archive
Requests
PATCH /api/v2/custom_fields/15/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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "15",
"type": "custom_fields",
"attributes": {
"name": "Priority",
"data_type_id": 3,
"required": false,
"description": null,
"archived_at": "2021-01-24T00:03:48.000+01:00",
"aggregation_type_id": null,
"customizable_type": "deals"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 183
}
},
"project": {
"data": null
},
"options": {
"data": [
{
"type": "custom_field_options",
"id": "8"
},
{
"type": "custom_field_options",
"id": "9"
},
{
"type": "custom_field_options",
"id": "10"
}
]
}
}
},
"included": [
{
"id": "8",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": "2021-01-24T00:03:48.000+01:00",
"position": 1,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 183
}
},
"custom_field": {
"data": {
"type": "custom_fields",
"id": "15"
}
}
}
},
{
"id": "9",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": "2021-01-24T00:03:48.000+01:00",
"position": 2,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 183
}
},
"custom_field": {
"data": {
"type": "custom_fields",
"id": "15"
}
}
}
},
{
"id": "10",
"type": "custom_field_options",
"attributes": {
"name": "High",
"archived_at": "2021-01-24T00:03:48.000+01:00",
"position": 3,
"color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 183
}
},
"custom_field": {
"data": {
"type": "custom_fields",
"id": "15"
}
}
}
}
],
"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": {}
}
}
Archives a custom fieldPATCH/api/v2/custom_fields/{id}/archive
URI Parameters
- id
number
(required) Example: 1custom field id
Generated by aglio on 23 Jan 2021