API Documentation

API Endpoint

Entitlements

Entitlements

GET /api/v2/entitlements
Requestsreturns entitlementsreturns entitlements

GET  /api/v2/entitlements

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": "17",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-09-20",
        "end_date": "2021-10-01",
        "allocated": 21,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "78"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "663"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "18",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-09-20",
        "end_date": "2021-10-01",
        "allocated": 21,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "79"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "664"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "19",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-09-20",
        "end_date": "2021-10-01",
        "allocated": 21,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "80"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "665"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "78",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        }
      }
    },
    {
      "id": "663",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user664@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:04:44.000+02:00",
        "is_user": true,
        "user_id": 664,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:04:44.460+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "860"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "79",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        }
      }
    },
    {
      "id": "664",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user665@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:04:44.000+02:00",
        "is_user": true,
        "user_id": 665,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:04:44.499+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "861"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "80",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        }
      }
    },
    {
      "id": "665",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user666@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:04:44.000+02:00",
        "is_user": true,
        "user_id": 666,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:04:44.544+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "862"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "860",
      "type": "companies",
      "attributes": {
        "name": "Client577",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:04:44.457+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        }
      }
    },
    {
      "id": "861",
      "type": "companies",
      "attributes": {
        "name": "Client578",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:04:44.496+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        }
      }
    },
    {
      "id": "862",
      "type": "companies",
      "attributes": {
        "name": "Client579",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:04:44.540+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 282
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/entitlements?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/entitlements?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
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

GET  /api/v2/entitlements

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": "27",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-09-20",
        "end_date": "2021-10-01",
        "allocated": 21,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "100"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1596"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "28",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-09-20",
        "end_date": "2021-10-01",
        "allocated": 21,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "101"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1597"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "29",
      "type": "entitlements",
      "attributes": {
        "start_date": "2021-09-20",
        "end_date": "2021-10-01",
        "allocated": 21,
        "used": 0,
        "pending": 0,
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "102"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1598"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "100",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        }
      }
    },
    {
      "id": "1596",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1546@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:55.000+02:00",
        "is_user": true,
        "user_id": 1586,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:55.244+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2126"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "101",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        }
      }
    },
    {
      "id": "1597",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1547@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:55.000+02:00",
        "is_user": true,
        "user_id": 1587,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:55.281+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2127"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "102",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        }
      }
    },
    {
      "id": "1598",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1548@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:55.000+02:00",
        "is_user": true,
        "user_id": 1588,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:55.322+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2128"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2126",
      "type": "companies",
      "attributes": {
        "name": "Client1502",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:55.240+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        }
      }
    },
    {
      "id": "2127",
      "type": "companies",
      "attributes": {
        "name": "Client1503",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:55.278+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        }
      }
    },
    {
      "id": "2128",
      "type": "companies",
      "attributes": {
        "name": "Client1504",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:55.318+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 625
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/entitlements?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/entitlements?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
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get entitlements
GET/api/v2/entitlements

GET /api/v2/entitlements/1
Requestsreturns entitlementreturns entitlement

GET  /api/v2/entitlements/20

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": "20",
    "type": "entitlements",
    "attributes": {
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "pending": 0,
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 283
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "81"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "667"
        }
      },
      "approval_workflow": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "81",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 283
          }
        }
      }
    },
    {
      "id": "667",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user668@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:04:44.000+02:00",
        "is_user": true,
        "user_id": 668,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:04:44.678+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 283
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "864"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "864",
      "type": "companies",
      "attributes": {
        "name": "Client580",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:04:44.674+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 283
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

GET  /api/v2/entitlements/30

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": "30",
    "type": "entitlements",
    "attributes": {
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "pending": 0,
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 626
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "103"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1600"
        }
      },
      "approval_workflow": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "103",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 626
          }
        }
      }
    },
    {
      "id": "1600",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1550@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:55.000+02:00",
        "is_user": true,
        "user_id": 1590,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:55.458+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 626
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2130"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "2130",
      "type": "companies",
      "attributes": {
        "name": "Client1505",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:55.454+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 626
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets a entitlement
GET/api/v2/entitlements/{id}

URI Parameters
HideShow
id
number (required) Example: 1

entitlement id

POST /api/v2/entitlements
Requestscreates the dashboardreturns errorreturns errorreturns errorcreates the dashboardreturns errorreturns errorreturns error

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {
      "id": null,
      "account_id": 284,
      "event_id": 82,
      "person_id": 669,
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": 0
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "21",
    "type": "entitlements",
    "attributes": {
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "pending": 0,
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 284
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "82"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "669"
        }
      },
      "approval_workflow": {
        "data": {
          "type": "approval_workflows",
          "id": "27"
        }
      }
    }
  },
  "included": [
    {
      "id": "82",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 284
          }
        }
      }
    },
    {
      "id": "669",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user670@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:04:44.000+02:00",
        "is_user": true,
        "user_id": 670,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:04:44.799+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 284
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "866"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "27",
      "type": "approval_workflows",
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 284
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "82"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "669"
          }
        },
        "approvers": {
          "data": []
        },
        "subscribers": {
          "data": []
        }
      }
    },
    {
      "id": "866",
      "type": "companies",
      "attributes": {
        "name": "Client581",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:04:44.795+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 284
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {}
  }
}
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/event"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/person"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/start_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/start_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/end_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/end_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be >= used",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    }
  ]
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {
      "id": null,
      "account_id": 286,
      "event_id": 84,
      "person_id": 0,
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": 0
    }
  }
}
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/person"
      }
    }
  ]
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {
      "id": null,
      "account_id": 287,
      "event_id": 0,
      "person_id": 674,
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": 0
    }
  }
}
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/event"
      }
    }
  ]
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {
      "id": null,
      "account_id": 627,
      "event_id": 104,
      "person_id": 1602,
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": 0
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "31",
    "type": "entitlements",
    "attributes": {
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "pending": 0,
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 627
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "104"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1602"
        }
      },
      "approval_workflow": {
        "data": {
          "type": "approval_workflows",
          "id": "29"
        }
      }
    }
  },
  "included": [
    {
      "id": "104",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 627
          }
        }
      }
    },
    {
      "id": "1602",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1552@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:55.000+02:00",
        "is_user": true,
        "user_id": 1592,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:55.582+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 627
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2132"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "29",
      "type": "approval_workflows",
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 627
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "104"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1602"
          }
        },
        "approvers": {
          "data": []
        },
        "subscribers": {
          "data": []
        }
      }
    },
    {
      "id": "2132",
      "type": "companies",
      "attributes": {
        "name": "Client1506",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:55.578+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 627
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {}
  }
}
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/event"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/person"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/start_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/start_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/end_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/end_date"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be >= used",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    }
  ]
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {
      "id": null,
      "account_id": 629,
      "event_id": 106,
      "person_id": 0,
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": 0
    }
  }
}
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/person"
      }
    }
  ]
}

POST  /api/v2/entitlements

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": "entitlements",
    "attributes": {
      "id": null,
      "account_id": 630,
      "event_id": 0,
      "person_id": 1607,
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 21,
      "used": 0,
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": 0
    }
  }
}
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/event"
      }
    }
  ]
}

Creates an entitlement
POST/api/v2/entitlements

URI Parameters
HideShow
event_id
number (required) Example: 1

event id

person_id
number (required) Example: 1

person id

start_date
date (required) Example: Sep+24%2C+2021+at++1%3A03+am

entitlement start date

end_date
date (required) Example: Dec+21%2C+2021+at++1%3A03+am

entitlement end date

allocated
number (required) Example: 10

allocated days

PATCH /api/v2/entitlements/1
Requestsupdates entitlementreturns errorreturns errorupdates entitlementreturns errorreturns error

PATCH  /api/v2/entitlements/22

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": "entitlements",
    "attributes": {
      "allocated": 15
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "22",
    "type": "entitlements",
    "attributes": {
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 15,
      "used": 13,
      "pending": 4,
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 288
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "85"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "676"
        }
      },
      "approval_workflow": {
        "data": {
          "type": "approval_workflows",
          "id": "28"
        }
      }
    }
  },
  "included": [
    {
      "id": "85",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 288
          }
        }
      }
    },
    {
      "id": "676",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user677@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:04:45.000+02:00",
        "is_user": true,
        "user_id": 677,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:04:45.250+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 288
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "873"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "28",
      "type": "approval_workflows",
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 288
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "85"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "676"
          }
        },
        "approvers": {
          "data": []
        },
        "subscribers": {
          "data": []
        }
      }
    },
    {
      "id": "873",
      "type": "companies",
      "attributes": {
        "name": "Client584",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:04:45.246+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 288
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/entitlements/23

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": "entitlements",
    "attributes": {
      "allocated": ""
    }
  }
}
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/allocated"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be >= used",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    }
  ]
}

PATCH  /api/v2/entitlements/24

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": "entitlements",
    "attributes": {
      "allocated": 15
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be >= used",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    }
  ]
}

PATCH  /api/v2/entitlements/32

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": "entitlements",
    "attributes": {
      "allocated": 15
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "32",
    "type": "entitlements",
    "attributes": {
      "start_date": "2021-09-20",
      "end_date": "2021-10-01",
      "allocated": 15,
      "used": 13,
      "pending": 4,
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 631
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "107"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1609"
        }
      },
      "approval_workflow": {
        "data": {
          "type": "approval_workflows",
          "id": "30"
        }
      }
    }
  },
  "included": [
    {
      "id": "107",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_slack": true,
        "sync_calendar": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 631
          }
        }
      }
    },
    {
      "id": "1609",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1559@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "setting_role_id": null,
        "invited_at": "2021-09-21T01:05:56.000+02:00",
        "is_user": true,
        "user_id": 1599,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:56.029+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 631
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "2139"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "30",
      "type": "approval_workflows",
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 631
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "107"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1609"
          }
        },
        "approvers": {
          "data": []
        },
        "subscribers": {
          "data": []
        }
      }
    },
    {
      "id": "2139",
      "type": "companies",
      "attributes": {
        "name": "Client1509",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2021-09-21T01:05:56.024+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 631
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "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
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/entitlements/33

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": "entitlements",
    "attributes": {
      "allocated": ""
    }
  }
}
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/allocated"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be >= used",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    }
  ]
}

PATCH  /api/v2/entitlements/34

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "entitlements",
    "attributes": {
      "allocated": 15
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be >= used",
      "source": {
        "pointer": "data/attributes/allocated"
      }
    }
  ]
}

Updates an entitlement
PATCH/api/v2/entitlements/{id}

URI Parameters
HideShow
id
number (required) Example: 1

entitlement id

DELETE /api/v2/entitlements/1
Requestsdeletes entitlementdeletes entitlement

DELETE  /api/v2/entitlements/25

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.

DELETE  /api/v2/entitlements/35

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 an entitlement
DELETE/api/v2/entitlements/{id}

URI Parameters
HideShow
id
number (required) Example: 1

entitlement id

Generated by aglio on 20 Sep 2021