# Read a role offer

Returns one role offer's configuration, the human-readable form of each of its
values, and what the calling user is permitted to do with it.
permissions.apply says whether the caller can apply right now. When it is false,
permissions.apply_error and permissions.apply_code give the reason, which is the
value to surface rather than a generic message.

Endpoint: GET /api/v2/headcount/roleoffer/{id}
Version: 2.0.0
Security: default

## Path parameters:

  - `id` (integer, required)
    The ID of the role offer.

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `object` (object)

  - `object.id` (integer)

  - `object.headcount_functional_area_job_title_id` (integer)

  - `object.headcount_location_venue_id` (integer)

  - `object.journey_id` (string | null)

  - `object.role_offer_template_id` (string | null)

  - `object.user_type_id` (integer)

  - `object.certificate_id` (string | null)

  - `object.static_demand` (integer)

  - `object.reserve_demand` (integer)

  - `object.waitlist_demand` (integer)

  - `object.confidence_level` (integer)

  - `object.calculate_demand` (integer)

  - `object.refund_on_application_withdraw` (integer)

  - `object.refund_on_role_offer_complete` (integer)

  - `object.user_per_shift` (integer)

  - `object.peak_shift` (integer)

  - `object.min_demand` (integer)

  - `object.number_of_shifts_per_day` (integer)

  - `object.min_number_shift_users` (integer)

  - `object.max_number_shift_users` (integer)

  - `object.start_date` (string | null)

  - `object.end_date` (string | null)

  - `object.role_feedback_form_id` (string | null)

  - `object.secondary_assignment_demand` (integer)

  - `object.rules` (array)

  - `object.ranking` (string | null)

  - `object.expires_in` (integer)

  - `object.preassign_enabled` (integer)

  - `object.sort_order` (integer)

  - `object.accept_form_id` (string | null)

  - `object.reject_form_id` (string | null)

  - `object.training_ids` (array)

  - `object.payment` (string | null)

  - `object.publish` (integer)

  - `object.promoted` (integer)

  - `object.is_archived` (integer)

  - `object.is_refund_allowed` (integer)

  - `object.created_by` (string | null)

  - `object.grid_image` (string | null)

  - `object.banner_image` (string | null)

  - `object.public` (integer)

  - `object.approval_status` (string)

  - `object.approval_reason` (string | null)

  - `object.visibility_show_groups` (array)

  - `object.visibility_hide_groups` (array)

  - `object.can_self_apply` (integer)

  - `object.application_form_id` (string | null)

  - `object.withdraw_form_id` (string | null)

  - `object.allows_application_withdrawals` (integer)

  - `object.timezone` (string | null)

  - `object.apps_open_timestamp` (string | null)

  - `object.apps_close_timestamp` (string | null)

  - `object.withdraw_close_timestamp` (string | null)

  - `object.minimum_dob` (string | null)

  - `object.minimum_age` (string | null)

  - `object.maximum_dob` (string | null)

  - `object.maximum_age` (string | null)

  - `object.applied_status_default` (string | null)

  - `object.withdrawn_status_default` (string | null)

  - `object.journey_complete_status_default` (string | null)

  - `object.deleted_at` (string | null)

  - `object.is_erased` (integer)

  - `object.strict_applications_enabled` (integer)

  - `object.waitlist_auto_invitation_enabled` (integer)

  - `object.created_at` (string)

  - `object.updated_at` (string)

  - `object.deleted_by` (string | null)

  - `object.description` (string)

  - `object.tags` (string | null)

  - `nice` (object)

  - `nice.rrn` (string)

  - `nice.accept_form_id` (string | null)

  - `nice.accept_form_id:value` (string | null)

  - `nice.accept_form_id:array` (string | null)

  - `nice.allows_application_withdrawals` (string)

  - `nice.application_form_id` (string | null)

  - `nice.application_form_id:value` (string | null)

  - `nice.application_form_id:array` (string | null)

  - `nice.applied_status_default` (string | null)

  - `nice.applied_status_default:value` (string | null)

  - `nice.applied_status_default:array` (string | null)

  - `nice.approval_status` (string)

  - `nice.approval_status:value` (string)

  - `nice.approval_status:array` (string)

  - `nice.banner_image` (string)

  - `nice.calculate_demand` (string)

  - `nice.can_self_apply` (string)

  - `nice.created_at` (string)

  - `nice.created_at__date` (string)

  - `nice.created_at__time` (string)

  - `nice.created_at__offset` (string)

  - `nice.created_at__offset_minutes` (integer)

  - `nice.created_at__dayofweek` (string)

  - `nice.feedback_form_id` (string | null)

  - `nice.feedback_form_id:value` (string | null)

  - `nice.feedback_form_id:array` (string | null)

  - `nice.grid_image` (string)

  - `nice.headcount_functional_area_job_title_id` (string)

  - `nice.headcount_functional_area_job_title_id:value` (integer)

  - `nice.headcount_functional_area_job_title_id:array` (string)

  - `nice.headcount_location_venue_id` (string)

  - `nice.headcount_location_venue_id:value` (integer)

  - `nice.headcount_location_venue_id:array` (string)

  - `nice.is_refund_allowed` (string)

  - `nice.journey_complete_status_default` (string | null)

  - `nice.journey_complete_status_default:value` (string | null)

  - `nice.journey_complete_status_default:array` (string | null)

  - `nice.journey_id` (string | null)

  - `nice.journey_id:value` (string | null)

  - `nice.journey_id:array` (string | null)

  - `nice.minimum_age` (string)

  - `nice.preassign_enabled` (string)

  - `nice.promoted` (string)

  - `nice.public` (string)

  - `nice.publish` (string)

  - `nice.reject_form_id` (string | null)

  - `nice.reject_form_id:value` (string | null)

  - `nice.reject_form_id:array` (string | null)

  - `nice.tags` (string | null)

  - `nice.tags:value` (string | null)

  - `nice.tags:array` (string | null)

  - `nice.training_ids` (string)

  - `nice.training_ids:value` (string)

  - `nice.training_ids:array` (array)

  - `nice.updated_at` (string)

  - `nice.updated_at__date` (string)

  - `nice.updated_at__time` (string)

  - `nice.updated_at__offset` (string)

  - `nice.updated_at__offset_minutes` (integer)

  - `nice.updated_at__dayofweek` (string)

  - `nice.user_type_id` (string)

  - `nice.user_type_id:value` (integer)

  - `nice.user_type_id:array` (string)

  - `nice.visibility_hide_groups` (string)

  - `nice.visibility_show_groups` (string)

  - `nice.withdraw_form_id` (string | null)

  - `nice.withdraw_form_id:value` (string | null)

  - `nice.withdraw_form_id:array` (string | null)

  - `nice.withdrawn_status_default` (string | null)

  - `nice.withdrawn_status_default:value` (string | null)

  - `nice.withdrawn_status_default:array` (string | null)

  - `nice.account_id` (integer)

  - `nice.account_url` (string)

  - `nice.confidence_level` (string)

  - `relations` (array)

  - `permissions` (object)

  - `permissions.read` (boolean)

  - `permissions.update` (boolean)

  - `permissions.delete` (boolean)

  - `permissions.accept` (boolean)

  - `permissions.reject` (boolean)

  - `permissions.withdraw` (boolean)

  - `permissions.apply` (boolean)

  - `permissions.apply_error` (string)

  - `permissions.apply_error_code` (integer)

  - `permissions.update_application_form` (boolean)