Entitlements

Creates an entitlement

Changed on

Create a new entitlement.

post/api/v2/entitlements

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/entitlements
  • Auth
    none declared

Request body

Example request

{
  "data": {
    "type": "entitlements",
    "attributes": {
      "start_date": "2026-01-01",
      "end_date": "2026-12-31",
      "allocated": 1200,
      "note": "Annual vacation entitlement 2026"
    },
    "relationships": {
      "event": {
        "data": {
          "type": "events",
          "id": "10"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "12"
        }
      }
    }
  }
}

Response

Single entitlement

Example response

{
  "data": {
    "id": "23",
    "type": "entitlements",
    "attributes": {
      "start_date": "2026-01-01",
      "end_date": "2026-12-31",
      "allocated": 1200,
      "used": 480,
      "pending": 960,
      "note": "Annual vacation entitlement 2026"
    },
    "relationships": {
      "event": {
        "data": {
          "type": "events",
          "id": "10"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "12"
        }
      }
    }
  },
  "included": []
}

Changes

    • warning

      added the new bad_decimal_format enum value to the // response property for the response status

    • warning

      added the new non_finite_number enum value to the // response property for the response status

    • warning

      added the new null_bytes_in_params enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

      the // response's property type changed from number to string for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from number to string for status

    • breaking

      the // response's property type changed from number to string for status

    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      added to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      removed subschema #1: Single data from the // response property anyOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property ///// became required for the status

    This list may be incomplete.