API Documentation
Activities ¶
Activities ¶
Supported filter params
-
task_id (array)
-
project_id (array)
-
deal_id (array)
-
invoice_id (array)
-
company_id (array)
-
person_id (array)
-
creator_id (array)
-
pinned
-
has_attachments
-
parent_type (1: Comment, 2: Changeset, 3: Email)
-
root_type (1: Comment, 2: Changeset, 3: Email)
-
after
-
before
GET /api/v2/activities
Requests
GET /api/v2/activities?filter[task_id]=1
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": "activities",
"attributes": {
"event": "create",
"changeset": [],
"item_id": 1,
"item_type": "task",
"item_name": "#1: Ticket title",
"item_deleted_at": null,
"parent_id": 1,
"parent_type": "project",
"parent_name": "test project",
"parent_deleted_at": null,
"root_id": 1,
"root_type": "project",
"root_name": "test project",
"root_deleted_at": null,
"deal_is_budget": false,
"task_id": 1,
"deal_id": null,
"invoice_id": null,
"company_id": null,
"person_id": null,
"created_at": "2021-04-15T01:02:42.627+02:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1
}
},
"creator": {
"data": {
"type": "people",
"id": "1"
}
},
"comment": {
"data": null
},
"email": {
"data": null
},
"attachment": {
"data": null
}
}
}
],
"included": [
{
"id": "1",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1@email.com",
"title": null,
"joined_at": "2021-04-15T01:02:42.000+02:00",
"last_seen_at": "2021-04-15T01:02:42.708+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 1,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:02:42.130+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1
}
},
"company": {
"data": {
"type": "companies",
"id": "1"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1",
"type": "companies",
"attributes": {
"name": "Organization1",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:02:42.128+02: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": 1
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/activities?filter%5Btask_id%5D=1&page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get activitiesGET/api/v2/activities
GET /api/v2/activities/1
Requests
GET /api/v2/activities/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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "6",
"type": "activities",
"attributes": {
"event": "create",
"changeset": [],
"item_id": 6,
"item_type": "task",
"item_name": "#1: Ticket title",
"item_deleted_at": null,
"parent_id": 16,
"parent_type": "project",
"parent_name": "test project",
"parent_deleted_at": null,
"root_id": 16,
"root_type": "project",
"root_name": "test project",
"root_deleted_at": null,
"deal_is_budget": false,
"task_id": 6,
"deal_id": null,
"invoice_id": null,
"company_id": null,
"person_id": null,
"created_at": "2021-04-15T01:02:44.709+02:00"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 4
}
},
"creator": {
"data": {
"type": "people",
"id": "31"
}
},
"comment": {
"data": null
},
"email": {
"data": null
},
"attachment": {
"data": null
}
}
},
"included": [
{
"id": "31",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user31@email.com",
"title": null,
"joined_at": "2021-04-15T01:02:44.000+02:00",
"last_seen_at": "2021-04-15T01:02:44.721+02:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"user_id": 31,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-04-15T01:02:44.452+02:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 4
}
},
"company": {
"data": {
"type": "companies",
"id": "46"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "46",
"type": "companies",
"attributes": {
"name": "Organization4",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-04-15T01:02:44.451+02: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": 4
}
},
"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
},
"pulse": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Generated by aglio on 14 Apr 2021