API Documentation

API Endpoint

Filters

Filters

Supported filter params

  • id

  • project_id (array)

  • filterable_collection

GET /api/v2/filters
Requestsreturns filters

GET  /api/v2/filters

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1-projects",
      "type": "filters",
      "attributes": {
        "name": "filter test name",
        "filterable_id": null,
        "filterable_type": null,
        "filterable_collection": "projects",
        "original_id": 1,
        "public": false,
        "default": false,
        "columns": null,
        "params": {
          "name": "person",
          "assignee": "2"
        },
        "export_params": {},
        "sort_by": null,
        "group_by": null,
        "layout_id": null,
        "transpose_by": null,
        "report": false,
        "description": null,
        "chart_type_id": null,
        "report_layout_id": null,
        "column_settings": null,
        "created_at": "2021-04-15T01:03:48.148+02:00",
        "updated_at": "2021-04-15T01:03:48.148+02:00",
        "formulas": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 308
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "762"
          }
        },
        "report_category": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "762",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user763@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:48.000+02:00",
        "last_seen_at": "2021-04-15T01:03:48.165+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 763,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:48.100+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 308
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1041"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1041",
      "type": "companies",
      "attributes": {
        "name": "Organization308",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:48.099+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": 308
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/filters?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/filters?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,
        "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 filters
GET/api/v2/filters

GET /api/v2/filters/1
Requestsreturns filter

GET  /api/v2/filters/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2-projects",
    "type": "filters",
    "attributes": {
      "name": "filter test name",
      "filterable_id": null,
      "filterable_type": null,
      "filterable_collection": "projects",
      "original_id": 2,
      "public": false,
      "default": false,
      "columns": null,
      "params": {
        "name": "person",
        "assignee": "2"
      },
      "export_params": {},
      "sort_by": null,
      "group_by": null,
      "layout_id": null,
      "transpose_by": null,
      "report": false,
      "description": null,
      "chart_type_id": null,
      "report_layout_id": null,
      "column_settings": null,
      "created_at": "2021-04-15T01:03:48.248+02:00",
      "updated_at": "2021-04-15T01:03:48.248+02:00",
      "formulas": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 309
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "763"
        }
      },
      "report_category": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "763",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user764@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:48.000+02:00",
        "last_seen_at": "2021-04-15T01:03:48.263+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 764,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:48.227+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 309
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1042"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1042",
      "type": "companies",
      "attributes": {
        "name": "Organization309",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:48.226+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": 309
          }
        },
        "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": {}
  }
}

Gets a filter
GET/api/v2/filters/{id}

URI Parameters
HideShow
id
number (required) Example: 1

filter id

POST /api/v2/filters
Requestscreates filtercreates filterreturns errorreturns error

POST  /api/v2/filters

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": "filters",
    "attributes": {
      "name": "test name",
      "filterable_collection": "invoices",
      "params": {
        "pay_on_after": "2020-01-08",
        "pay_on_before": "2020-01-18",
        "pay_on_interval_id": "10"
      },
      "layout_id": "1"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4-invoices",
    "type": "filters",
    "attributes": {
      "name": "test name",
      "filterable_id": null,
      "filterable_type": null,
      "filterable_collection": "invoices",
      "original_id": 4,
      "public": false,
      "default": false,
      "columns": null,
      "params": {
        "pay_on_after": "2020-01-08",
        "pay_on_before": "2020-01-18",
        "pay_on_interval_id": "10"
      },
      "export_params": {},
      "sort_by": null,
      "group_by": null,
      "layout_id": 1,
      "transpose_by": null,
      "report": false,
      "description": null,
      "chart_type_id": null,
      "report_layout_id": null,
      "column_settings": null,
      "created_at": "2021-04-15T01:03:48.358+02:00",
      "updated_at": "2021-04-15T01:03:48.358+02:00",
      "formulas": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 310
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "764"
        }
      },
      "report_category": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "764",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user765@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:48.000+02:00",
        "last_seen_at": "2021-04-15T01:03:48.350+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 765,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:48.315+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 310
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1043"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1043",
      "type": "companies",
      "attributes": {
        "name": "Organization310",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:48.314+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": 310
          }
        },
        "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": {}
  }
}

POST  /api/v2/filters

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": "filters",
    "attributes": {
      "name": "test name",
      "filterable_collection": "projects",
      "report_category_id": "1",
      "params": {}
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "6-projects",
    "type": "filters",
    "attributes": {
      "name": "test name",
      "filterable_id": null,
      "filterable_type": null,
      "filterable_collection": "projects",
      "original_id": 6,
      "public": false,
      "default": false,
      "columns": null,
      "params": {},
      "export_params": {},
      "sort_by": null,
      "group_by": null,
      "layout_id": null,
      "transpose_by": null,
      "report": false,
      "description": null,
      "chart_type_id": null,
      "report_layout_id": null,
      "column_settings": null,
      "created_at": "2021-04-15T01:03:48.469+02:00",
      "updated_at": "2021-04-15T01:03:48.469+02:00",
      "formulas": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 311
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "765"
        }
      },
      "report_category": {
        "data": {
          "type": "report_categories",
          "id": "1"
        }
      }
    }
  },
  "included": [
    {
      "id": "765",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user766@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:48.000+02:00",
        "last_seen_at": "2021-04-15T01:03:48.462+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 766,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:48.417+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 311
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1044"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1",
      "type": "report_categories",
      "attributes": {
        "name": "category",
        "position": 1,
        "color_id": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 311
          }
        }
      }
    },
    {
      "id": "1044",
      "type": "companies",
      "attributes": {
        "name": "Organization311",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:48.416+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": 311
          }
        },
        "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": {}
  }
}

POST  /api/v2/filters

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": "filters",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
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/filterable_collection"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/filterable_type"
      }
    }
  ]
}

POST  /api/v2/filters

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": "filters",
    "attributes": {
      "name": "test name",
      "filterable_collection": "projects",
      "report_category_id": "not_a_number"
    }
  }
}
Responses422
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/report_category"
      }
    }
  ]
}

Create a filter
POST/api/v2/filters

URI Parameters
HideShow
name
string (required) Example: Name

name

filterable_collection
string (required) Example: Project

filterable collection

filterable_type
string (required) Example: Tasks

filterable type

PATCH /api/v2/filters/1
Requestsupdates filterreturns error

PATCH  /api/v2/filters/12

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": "filters",
    "attributes": {
      "name": "new name",
      "params": {}
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "12-projects",
    "type": "filters",
    "attributes": {
      "name": "new name",
      "filterable_id": null,
      "filterable_type": null,
      "filterable_collection": "projects",
      "original_id": 12,
      "public": false,
      "default": false,
      "columns": null,
      "params": {},
      "export_params": {},
      "sort_by": null,
      "group_by": null,
      "layout_id": null,
      "transpose_by": null,
      "report": false,
      "description": null,
      "chart_type_id": null,
      "report_layout_id": null,
      "column_settings": null,
      "created_at": "2021-04-15T01:03:48.925+02:00",
      "updated_at": "2021-04-15T01:03:48.947+02:00",
      "formulas": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 316
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "771"
        }
      },
      "report_category": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "771",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user772@email.com",
        "title": null,
        "joined_at": "2021-04-15T01:03:48.000+02:00",
        "last_seen_at": "2021-04-15T01:03:48.940+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "user_id": 772,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-04-15T01:03:48.906+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0,
        "contact": {}
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 316
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1051"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1051",
      "type": "companies",
      "attributes": {
        "name": "Organization316",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-04-15T01:03:48.905+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": 316
          }
        },
        "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": {}
  }
}

PATCH  /api/v2/filters/13

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": "filters",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
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"
      }
    }
  ]
}

Update a filter
PATCH/api/v2/filters/{id}

URI Parameters
HideShow
id
number (required) Example: 1

filter id

DELETE /api/v2/filters/1
Requestsdeletes filter

DELETE  /api/v2/filters/15

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
Responses204
This response has no content.

Deletes a filter
DELETE/api/v2/filters/{id}

URI Parameters
HideShow
id
number (required) Example: 1

filter id

Generated by aglio on 14 Apr 2021