API Documentation
Attachments ¶
Attachments ¶
For more details on how to work with attachment files please refer to Working with attachments guide.
Supported filter params
-
comment_id (array)
-
page_id (array)
-
task_id (array)
GET /api/v2/attachments
Requests
GET /api/v2/attachments?filter[comment_id]=3
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": "attachments",
"attributes": {
"name": "img.png",
"content_type": "image/png",
"size": 3479,
"url": "https://files-test.productive.io/attachments/files/000/000/001/original/img.png?1711684903",
"thumb": "https://files-test.productive.io/attachments/files/000/000/001/thumb/img.png?1711684903",
"temp_url": "https://files-test.productive.io/attachments/files/000/000/001/original/img.png?1711684903",
"resized": false,
"created_at": "2024-03-29T05:01:43.810+01:00",
"deleted_at": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "13"
}
},
"creator": {
"data": {
"type": "people",
"id": "72"
}
},
"invoice": {
"data": null
},
"purchase_order": {
"data": null
},
"bill": {
"data": null
},
"email": {
"data": null
},
"page": {
"data": null
},
"expense": {
"data": null
},
"comment": {
"data": {
"type": "comments",
"id": "3"
}
},
"task": {
"data": null
},
"document_style": {
"data": null
},
"document_type": {
"data": null
}
}
}
],
"included": [
{
"id": "72",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user72@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-29T05:01:43.000+01:00",
"last_seen_at": "2024-03-29T05:01:43.848+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 72,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-29T05:01:43.760+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "13"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "72"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "3",
"type": "comments",
"attributes": {
"body": "test body",
"commentable_type": "company",
"created_at": "2024-03-29T05:01:43.793+01:00",
"deleted_at": null,
"draft": false,
"edited_at": null,
"hidden": false,
"pinned_at": null,
"reactions": {},
"updated_at": "2024-03-29T05:01:43.812+01:00",
"version_number": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "13"
}
},
"company": {
"data": {
"type": "companies",
"id": "32"
}
},
"creator": {
"data": {
"type": "people",
"id": "72"
}
},
"deal": {
"data": null
},
"discussion": {
"data": null
},
"invoice": {
"data": null
},
"person": {
"data": null
},
"pinned_by": {
"data": null
},
"task": {
"data": null
},
"purchase_order": {
"data": null
},
"attachments": {
"data": [
{
"type": "attachments",
"id": "1"
}
]
}
}
},
{
"id": "72",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "13"
}
}
}
},
{
"id": "32",
"type": "companies",
"attributes": {
"name": "Client19",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-29T05:01:43.790+01:00",
"last_activity_at": "2024-03-29T05:01:43.790+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "13"
}
},
"custom_field_people": {
"data": []
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/attachments?filter%5Bcomment_id%5D=3&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/attachments?filter%5Bcomment_id%5D=3&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
},
"deals_billable_time_rounding": {
"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 attachmentsGET/api/v2/attachments
GET /api/v2/attachments/1
Requests
GET /api/v2/attachments/2
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": "2",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": "image/png",
"size": 3479,
"url": "https://files-test.productive.io/attachments/files/000/000/002/original/img.png?1711684904",
"thumb": "https://files-test.productive.io/attachments/files/000/000/002/thumb/img.png?1711684904",
"temp_url": "https://files-test.productive.io/attachments/files/000/000/002/original/img.png?1711684904",
"resized": false,
"created_at": "2024-03-29T05:01:44.171+01:00",
"deleted_at": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "14"
}
},
"creator": {
"data": {
"type": "people",
"id": "73"
}
},
"invoice": {
"data": null
},
"purchase_order": {
"data": null
},
"bill": {
"data": null
},
"email": {
"data": null
},
"page": {
"data": null
},
"expense": {
"data": null
},
"comment": {
"data": {
"type": "comments",
"id": "4"
}
},
"task": {
"data": null
},
"document_style": {
"data": null
},
"document_type": {
"data": null
}
}
},
"included": [
{
"id": "73",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user73@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-29T05:01:44.000+01:00",
"last_seen_at": "2024-03-29T05:01:44.183+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 73,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-29T05:01:44.127+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "14"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "73"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "4",
"type": "comments",
"attributes": {
"body": "test body",
"commentable_type": "company",
"created_at": "2024-03-29T05:01:44.167+01:00",
"deleted_at": null,
"draft": false,
"edited_at": null,
"hidden": false,
"pinned_at": null,
"reactions": {},
"updated_at": "2024-03-29T05:01:44.172+01:00",
"version_number": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "14"
}
},
"company": {
"data": {
"type": "companies",
"id": "34"
}
},
"creator": {
"data": {
"type": "people",
"id": "73"
}
},
"deal": {
"data": null
},
"discussion": {
"data": null
},
"invoice": {
"data": null
},
"person": {
"data": null
},
"pinned_by": {
"data": null
},
"task": {
"data": null
},
"purchase_order": {
"data": null
},
"attachments": {
"data": [
{
"type": "attachments",
"id": "2"
}
]
}
}
},
{
"id": "73",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "14"
}
}
}
},
{
"id": "34",
"type": "companies",
"attributes": {
"name": "Client20",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-29T05:01:44.164+01:00",
"last_activity_at": "2024-03-29T05:01:44.164+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "14"
}
},
"custom_field_people": {
"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
},
"deals_billable_time_rounding": {
"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 attachmentGET/api/v2/attachments/{id}
URI Parameters
- id
number
(required) Example: 1attachment id
POST /api/v2/attachments
Requests
POST /api/v2/attachments
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": "attachments",
"attributes": {
"name": "img.png",
"attachable_id": 5,
"attachable_type": "comment"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": null,
"size": null,
"url": "https://files-test.productive.io/attachments/files/000/000/004/original/img.png",
"thumb": null,
"temp_url": null,
"resized": false,
"created_at": "2024-03-29T05:01:44.432+01:00",
"deleted_at": null,
"attachable_type": "comment",
"aws_policy": {
"key": "attachments/files/000/000/004/original/img.png",
"success_action_status": "201",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "AKIAJDSJUJWWOMVPNYZQ/20240329/us-test-1/s3/aws4_request",
"X-Amz-Date": "20240329T040144Z",
"X-Amz-Signature": "743e9ed6957e7efebde7b23b9c9c9432c206bf21081e2033130e7a303fe156c1",
"Policy": "eyJleHBpcmF0aW9uIjoiMjAyNC0wMy0yOVQxNDowMTo0NFoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJwcm9kdWN0aXZlLWZpbGVzLXRlc3QifSx7InN1Y2Nlc3NfYWN0aW9uX3N0YXR1cyI6IjIwMSJ9LHsia2V5IjoiYXR0YWNobWVudHMvZmlsZXMvMDAwLzAwMC8wMDQvb3JpZ2luYWwvaW1nLnBuZyJ9LHsiY29udGVudC10eXBlIjpudWxsfSx7IngtYW16LWFsZ29yaXRobSI6IkFXUzQtSE1BQy1TSEEyNTYifSx7IngtYW16LWNyZWRlbnRpYWwiOiJBS0lBSkRTSlVKV1dPTVZQTllaUS8yMDI0MDMyOS91cy10ZXN0LTEvczMvYXdzNF9yZXF1ZXN0In0seyJ4LWFtei1kYXRlIjoiMjAyNDAzMjlUMDQwMTQ0WiJ9XX0=",
"Content-Type": null
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "15"
}
},
"creator": {
"data": {
"type": "people",
"id": "74"
}
},
"invoice": {
"data": null
},
"purchase_order": {
"data": null
},
"bill": {
"data": null
},
"email": {
"data": null
},
"page": {
"data": null
},
"expense": {
"data": null
},
"comment": {
"data": null
},
"task": {
"meta": {
"included": false
}
},
"document_style": {
"data": null
},
"document_type": {
"data": null
}
}
},
"included": [
{
"id": "74",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user74@email.com",
"title": null,
"contact": null,
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": null,
"last_seen_at": null,
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 74,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-29T05:01:44.377+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "15"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "74"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "74",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "15"
}
}
}
}
],
"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
},
"deals_billable_time_rounding": {
"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/attachments
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": "attachments",
"attributes": {
"attachable_type": ""
}
}
}
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/attachable_type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/attachable_type"
}
}
]
}
Create a attachmentPOST/api/v2/attachments
URI Parameters
- name
string
(required) Example: namename
- id
string
(required) Example: Commentattachable_type
PATCH /api/v2/attachments/1
Requests
PATCH /api/v2/attachments/6
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": "attachments",
"attributes": {
"temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "6",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": "image/png",
"size": 3479,
"url": "https://files-test.productive.io/attachments/files/000/000/006/original/img.png?1711684904",
"thumb": "https://files-test.productive.io/attachments/files/000/000/006/thumb/img.png?1711684904",
"temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf",
"resized": false,
"created_at": "2024-03-29T05:01:44.729+01:00",
"deleted_at": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "17"
}
},
"creator": {
"data": {
"type": "people",
"id": "76"
}
},
"invoice": {
"data": null
},
"purchase_order": {
"data": null
},
"bill": {
"data": null
},
"email": {
"data": null
},
"page": {
"data": null
},
"expense": {
"data": null
},
"comment": {
"data": {
"type": "comments",
"id": "7"
}
},
"task": {
"data": null
},
"document_style": {
"data": null
},
"document_type": {
"data": null
}
}
},
"included": [
{
"id": "76",
"type": "people",
"attributes": {
"avatar_url": null,
"deactivated_at": null,
"first_name": "name",
"last_name": "surname",
"nickname": null,
"role_id": 1,
"email": "user76@email.com",
"title": null,
"contact": {},
"status_emoji": null,
"status_expires_at": null,
"status_text": null,
"joined_at": "2024-03-29T05:01:44.000+01:00",
"last_seen_at": "2024-03-29T05:01:44.742+01:00",
"archived_at": null,
"invited_at": null,
"is_user": true,
"user_id": 76,
"tag_list": [],
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2024-03-29T05:01:44.692+01:00",
"placeholder": false,
"color_id": null,
"sample_data": false,
"time_unlocked": false,
"time_unlocked_on": null,
"time_unlocked_start_date": null,
"time_unlocked_end_date": null,
"time_unlocked_period_id": null,
"time_unlocked_interval": null,
"last_activity_at": null,
"two_factor_auth": false,
"availabilities": "[]",
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "17"
}
},
"manager": {
"data": null
},
"company": {
"data": null
},
"subsidiary": {
"data": null
},
"holiday_calendar": {
"data": null
},
"custom_role": {
"data": {
"type": "roles",
"id": "76"
}
},
"teams": {
"data": []
},
"custom_field_people": {
"data": []
}
}
},
{
"id": "7",
"type": "comments",
"attributes": {
"body": "test body",
"commentable_type": "company",
"created_at": "2024-03-29T05:01:44.725+01:00",
"deleted_at": null,
"draft": false,
"edited_at": null,
"hidden": false,
"pinned_at": null,
"reactions": {},
"updated_at": "2024-03-29T05:01:44.751+01:00",
"version_number": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "17"
}
},
"company": {
"data": {
"type": "companies",
"id": "40"
}
},
"creator": {
"data": {
"type": "people",
"id": "76"
}
},
"deal": {
"data": null
},
"discussion": {
"data": null
},
"invoice": {
"data": null
},
"person": {
"data": null
},
"pinned_by": {
"data": null
},
"task": {
"data": null
},
"purchase_order": {
"data": null
},
"attachments": {
"data": [
{
"type": "attachments",
"id": "6"
}
]
}
}
},
{
"id": "76",
"type": "roles",
"attributes": {
"base_role_id": 1,
"description": "test description",
"name": "test_role",
"people_count": 1,
"permissions": {},
"editable_by_user": false,
"user_type_id": 1
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "17"
}
}
}
},
{
"id": "40",
"type": "companies",
"attributes": {
"name": "Client23",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2024-03-29T05:01:44.722+01:00",
"last_activity_at": "2024-03-29T05:01:44.722+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"company_code": "CLIE",
"domain": null,
"projectless_budgets": false,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {},
"sample_data": false,
"settings": {},
"external_id": null,
"external_sync": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "17"
}
},
"custom_field_people": {
"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
},
"deals_billable_time_rounding": {
"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/attachments/7
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": "attachments",
"attributes": {
"attachable_type": ""
}
}
}
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/attachable_type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/attachable_type"
}
}
]
}
Update a attachmentPATCH/api/v2/attachments/{id}
URI Parameters
- id
number
(required) Example: 1attachment id
DELETE /api/v2/attachments/1
Requests
DELETE /api/v2/attachments/8
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.
Deletes a attachmentDELETE/api/v2/attachments/{id}
URI Parameters
- id
number
(required) Example: 1attachment id
Generated by aglio on 29 Mar 2024