API Documentation

API Endpoint

Entitlements

Entitlements

GET /api/v2/entitlements
Requestsreturns 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": "43",
      "type": "entitlements",
      "attributes": {
        "start_date": "2024-03-29",
        "end_date": "2024-04-18",
        "allocated": 21,
        "used": "0.0",
        "pending": "0.0",
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "99"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1619"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "44",
      "type": "entitlements",
      "attributes": {
        "start_date": "2024-03-29",
        "end_date": "2024-04-18",
        "allocated": 21,
        "used": "0.0",
        "pending": "0.0",
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "100"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1620"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    },
    {
      "id": "45",
      "type": "entitlements",
      "attributes": {
        "start_date": "2024-03-29",
        "end_date": "2024-04-18",
        "allocated": 21,
        "used": "0.0",
        "pending": "0.0",
        "note": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "event": {
          "data": {
            "type": "events",
            "id": "101"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1621"
          }
        },
        "approval_workflow": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "99",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_personal_integrations": true,
        "half_day_bookings": false,
        "description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        }
      }
    },
    {
      "id": "1619",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user1615@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-29T05:04:59.000+01:00",
        "is_user": true,
        "user_id": 1615,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-29T05:04:59.394+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-29T05:04:59.394+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1131"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "1608"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "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_personal_integrations": true,
        "half_day_bookings": false,
        "description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        }
      }
    },
    {
      "id": "1620",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user1616@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-29T05:04:59.000+01:00",
        "is_user": true,
        "user_id": 1616,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-29T05:04:59.426+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-29T05:04:59.426+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1131"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "1609"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "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_personal_integrations": true,
        "half_day_bookings": false,
        "description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        }
      }
    },
    {
      "id": "1621",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user1617@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-29T05:04:59.000+01:00",
        "is_user": true,
        "user_id": 1617,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-29T05:04:59.461+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-29T05:04:59.461+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1131"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "1610"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1131",
      "type": "companies",
      "attributes": {
        "name": "Organization424",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-29T05:04:59.381+01:00",
        "last_activity_at": "2024-03-29T05:04:59.381+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1608",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        }
      }
    },
    {
      "id": "1609",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        }
      }
    },
    {
      "id": "1610",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "424"
          }
        }
      }
    }
  ],
  "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": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "deals_billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get entitlements
GET/api/v2/entitlements


GET /api/v2/entitlements/1
Requestsreturns entitlement

GET  /api/v2/entitlements/46

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": "46",
    "type": "entitlements",
    "attributes": {
      "start_date": "2024-03-29",
      "end_date": "2024-04-18",
      "allocated": 21,
      "used": "0.0",
      "pending": "0.0",
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "425"
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "102"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1623"
        }
      },
      "approval_workflow": {
        "data": null
      }
    }
  },
  "included": [
    {
      "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_personal_integrations": true,
        "half_day_bookings": false,
        "description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "425"
          }
        }
      }
    },
    {
      "id": "1623",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user1619@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-29T05:04:59.000+01:00",
        "is_user": true,
        "user_id": 1619,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-29T05:04:59.631+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-29T05:04:59.631+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "425"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1132"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "1612"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1132",
      "type": "companies",
      "attributes": {
        "name": "Organization425",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-29T05:04:59.613+01:00",
        "last_activity_at": "2024-03-29T05:04:59.613+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "425"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1612",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "425"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "deals_billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

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

URI Parameters
HideShow
id
number (required) Example: 1

entitlement id


POST /api/v2/entitlements
Requestscreates the entitlementreturns 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": 426,
      "event_id": 103,
      "person_id": 1625,
      "start_date": "2024-03-29",
      "end_date": "2024-04-18",
      "allocated": 21,
      "used": "0.0",
      "deleted_at": null,
      "created_at": null,
      "updated_at": null,
      "creator_id": null,
      "updater_id": null,
      "note": null,
      "approval_workflow_id": null,
      "pending": "0.0",
      "import_id": null,
      "deleted_item_id": null
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "47",
    "type": "entitlements",
    "attributes": {
      "start_date": "2024-03-29",
      "end_date": "2024-04-18",
      "allocated": 21,
      "used": "0.0",
      "pending": "0.0",
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "426"
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "103"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1625"
        }
      },
      "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_personal_integrations": true,
        "half_day_bookings": false,
        "description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "426"
          }
        }
      }
    },
    {
      "id": "1625",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user1621@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-29T05:04:59.000+01:00",
        "is_user": true,
        "user_id": 1621,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-29T05:04:59.791+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-29T05:04:59.791+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "426"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1133"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "1614"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1133",
      "type": "companies",
      "attributes": {
        "name": "Organization426",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-29T05:04:59.774+01:00",
        "last_activity_at": "2024-03-29T05:04:59.774+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "426"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1614",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "426"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "deals_billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/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": "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: Apr++1%2C+2024+at++5%3A01+am

Entitlement start date

end_date
date (required) Example: Jun+29%2C+2024+at++5%3A01+am

Entitlement end date

allocated
number (required) Example: 10

This depends on the limitation type of the event for which the entitlement is made. If the event is limited by days, allocated is the number of allocated days. If the event is limited by hours, allocated is the number of allocated minutes (e.g. 40hrs > 2400mins => allocated = 2400)


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

PATCH  /api/v2/entitlements/48

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": "48",
    "type": "entitlements",
    "attributes": {
      "start_date": "2024-03-29",
      "end_date": "2024-04-18",
      "allocated": 15,
      "used": "13.0",
      "pending": "4.0",
      "note": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "428"
        }
      },
      "event": {
        "data": {
          "type": "events",
          "id": "105"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1629"
        }
      },
      "approval_workflow": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "105",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "icon_id": null,
        "color_id": null,
        "archived_at": null,
        "limitation_type_id": 2,
        "sync_personal_integrations": true,
        "half_day_bookings": false,
        "description": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "428"
          }
        }
      }
    },
    {
      "id": "1629",
      "type": "people",
      "attributes": {
        "avatar_url": null,
        "deactivated_at": null,
        "first_name": "name",
        "last_name": "surname",
        "nickname": null,
        "role_id": 3,
        "email": "user1625@email.com",
        "title": null,
        "contact": {},
        "status_emoji": null,
        "status_expires_at": null,
        "status_text": null,
        "joined_at": null,
        "last_seen_at": null,
        "archived_at": null,
        "invited_at": "2024-03-29T05:05:00.000+01:00",
        "is_user": true,
        "user_id": 1625,
        "tag_list": [],
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2024-03-29T05:05:00.091+01:00",
        "placeholder": false,
        "color_id": null,
        "sample_data": false,
        "time_unlocked": false,
        "time_unlocked_on": null,
        "time_unlocked_start_date": null,
        "time_unlocked_end_date": null,
        "time_unlocked_period_id": null,
        "time_unlocked_interval": null,
        "last_activity_at": "2024-03-29T05:05:00.091+01:00",
        "two_factor_auth": false,
        "availabilities": "[]",
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "428"
          }
        },
        "manager": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1135"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        },
        "custom_role": {
          "data": {
            "type": "roles",
            "id": "1618"
          }
        },
        "teams": {
          "data": []
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1135",
      "type": "companies",
      "attributes": {
        "name": "Organization428",
        "billing_name": null,
        "vat": null,
        "default_currency": null,
        "created_at": "2024-03-29T05:05:00.076+01:00",
        "last_activity_at": "2024-03-29T05:05:00.076+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": "ORGA",
        "domain": null,
        "projectless_budgets": false,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false,
        "settings": {},
        "external_id": null,
        "external_sync": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "428"
          }
        },
        "custom_field_people": {
          "data": []
        }
      }
    },
    {
      "id": "1618",
      "type": "roles",
      "attributes": {
        "base_role_id": 3,
        "description": "test description",
        "name": "test_role",
        "people_count": 1,
        "permissions": {},
        "editable_by_user": false,
        "user_type_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "428"
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 1000
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 1000
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 10
      },
      "workflows": {
        "type": "metered",
        "limit": 10
      },
      "rate_cards": {
        "type": "metered",
        "limit": 30
      },
      "teams": {
        "type": "metered",
        "limit": 20
      },
      "outgoing_emails": {
        "type": "metered",
        "limit": 100
      },
      "recycle_bin": {
        "type": "metered",
        "limit": 730
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "deals_billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      },
      "time_locking": {
        "type": "switch",
        "available": true
      },
      "docs": {
        "type": "switch",
        "available": true
      },
      "scheduling_resource_utilization": {
        "type": "switch",
        "available": true
      },
      "enforce_two_factor_auth": {
        "type": "switch",
        "available": true
      },
      "personio_integration": {
        "type": "switch",
        "available": true
      },
      "task_dependencies": {
        "type": "switch",
        "available": true
      },
      "hris_integration": {
        "type": "switch",
        "available": true
      },
      "numbering_scheme": {
        "type": "switch",
        "available": true
      },
      "automations": {
        "type": "metered",
        "limit": 5000
      },
      "dashboards_sharing": {
        "type": "switch",
        "available": true
      },
      "currency_picker": {
        "type": "switch",
        "available": true
      },
      "required_custom_fields": {
        "type": "switch",
        "available": true
      },
      "restricted_tracking": {
        "type": "switch",
        "available": true
      },
      "enforce_sso": {
        "type": "switch",
        "available": true
      },
      "jira_integration": {
        "type": "switch",
        "available": true
      },
      "docs_versions": {
        "type": "switch",
        "available": true
      },
      "zapier_integration": {
        "type": "switch",
        "available": true
      },
      "recurring_budgets": {
        "type": "switch",
        "available": true
      },
      "restricted_user_roles": {
        "type": "switch",
        "available": true
      },
      "service_tracking_toggle": {
        "type": "switch",
        "available": true
      },
      "repeating_tasks": {
        "type": "switch",
        "available": true
      },
      "save_public_and_private_view": {
        "type": "switch",
        "available": true
      },
      "overhead_cost": {
        "type": "switch",
        "available": true
      },
      "show_only_filtered_data": {
        "type": "switch",
        "available": true
      },
      "invoicing_integrations": {
        "type": "switch",
        "available": true
      },
      "audit_log": {
        "type": "switch",
        "available": true
      },
      "hubspot_integration": {
        "type": "switch",
        "available": true
      },
      "booking_activity_modal": {
        "type": "switch",
        "available": true
      },
      "person_custom_field": {
        "type": "switch",
        "available": true
      },
      "template_center": {
        "type": "switch",
        "available": true
      },
      "custom_roles": {
        "type": "switch",
        "available": true
      },
      "purchase_orders": {
        "type": "switch",
        "available": true
      },
      "payment_reminders": {
        "type": "switch",
        "available": true
      },
      "gantt": {
        "type": "switch",
        "available": true
      },
      "tentative_bookings": {
        "type": "switch",
        "available": true
      },
      "task_view_sharing": {
        "type": "switch",
        "available": true
      },
      "org_chart": {
        "type": "switch",
        "available": true
      },
      "person_status": {
        "type": "switch",
        "available": true
      },
      "deal_cost_rates": {
        "type": "switch",
        "available": true
      },
      "custom_man_days": {
        "type": "switch",
        "available": true
      },
      "workload_view": {
        "type": "switch",
        "available": true
      },
      "xero_expense_sync": {
        "type": "switch",
        "available": true
      },
      "rippling_integration": {
        "type": "switch",
        "available": true
      },
      "document_styler": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/entitlements/49

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": "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 entitlement

DELETE  /api/v2/entitlements/50

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 29 Mar 2024