# List a role offer's applications

Returns the people who have applied to, or been added to, the role offer in
the URL - one row per application, carrying the status each is at.
Applications whose user has since been deleted are **included**, unlike most
listings in the API, so the count here matches what the role offer's demand is
measured against.
The response is only wrapped in a paginated envelope when a `page` parameter is
sent. Without one, every match comes back as a flat array. Note that the
envelope carries no `total` and no `last_page` - page until `next_page_url` is
null rather than counting pages up front.
Related records are not included unless asked for. Requesting the `user`
relation returns that person's full profile, so ask for it only when the
profile is what you need - the application already carries `user_id`.

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

## Path parameters:

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

## Query parameters:

  - `per_page` (integer)
    The number of results to return per page. The higher the number the longer the request may take.
It is highly recommended to use this to avoid timeouts as your data grows.
Used in conjunction with the `page` parameter to paginate results.

  - `page` (integer)
    The page of results to return. Used in conjunction with the `per_page` parameter to paginate
results. If not specified, defaults to 1.
The response's next_page_url will be null if there are no
more pages.

  - `filter` (array)
    A filter to apply to the results. Declared as an array of objects, where each object
contains an attr (attribute code), operator and value key. Examples:

?filter[0]['attr']=name&filter[0][operator]=like&filter[0][value]=luke 

?filter[0]['attr']=id&filter[0][operator]=>&filter[0][value]=265 

See the filters documentation for more details on how to use this.

  - `sort_by` (string)
    The field to sort the results by. No ordering is applied unless you specify one, so
row order is not guaranteed. Always send it when paging through a list, otherwise
records can repeat or be missed between pages.
Example: id

  - `sort_order` (string)
    The direction to sort the results by. Can be 'asc' or 'desc', default is 'asc'.

  - `_locale` (string)
    The locale to use for the response. This primarily affects the results of the `nice` field, which
contain human-readable labels and terms, as well as locale-specific date formats.,

  - `extras` (array)
    A list of extras to include in the response. These are objects or arrays that are not part of
the model's primary attributes, such as stats and counts.
For fast responses, avoid requesting them if you don't need them.

  - `with` (array)
    A list of relations to include in the response. May be single records or collections.
It is often more efficient to retrieve this way, to avoid follow-up API calls.

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `current_page` (integer)

  - `data` (array)

  - `data.object` (object)

  - `data.object.id` (integer)

  - `data.object.role_offer_id` (integer)

  - `data.object.user_id` (integer)

  - `data.object.status_id` (integer)

  - `data.object.ranking` (integer)

  - `data.object.role_offer_feedback_form_completed_at` (string | null)

  - `data.object.secondary_assignment` (integer)

  - `data.object.expires_at` (string | null)

  - `data.object.feedback` (string | null)

  - `data.object.status_update_at` (string)

  - `data.object.application_form_completed_at` (string)

  - `data.object.application_withdrawn_at` (string | null)

  - `data.object.sort_order` (integer)

  - `data.object.waitlist_invitation_email_sent_at` (string | null)

  - `data.object.waitlist_reminder_email_sent_at` (string | null)

  - `data.object.is_reserved` (integer)

  - `data.object.deleted_at` (string | null)

  - `data.object.is_erased` (integer)

  - `data.object.created_at` (string)

  - `data.object.updated_at` (string)

  - `data.object.deleted_by` (string | null)

  - `data.nice` (object)

  - `data.nice.rrn` (string)

  - `data.nice.journey_step` (string)

  - `data.nice.journey_step_category` (string | null)

  - `data.nice.created_at` (string)

  - `data.nice.created_at__date` (string)

  - `data.nice.created_at__time` (string)

  - `data.nice.created_at__offset` (string)

  - `data.nice.created_at__offset_minutes` (integer)

  - `data.nice.created_at__dayofweek` (string)

  - `data.nice.feedback` (string)

  - `data.nice.status_id` (string)

  - `data.nice.status_id:value` (integer)

  - `data.nice.status_id:array` (string)

  - `data.nice.status_update_at` (string)

  - `data.nice.status_update_at__date` (string)

  - `data.nice.status_update_at__time` (string)

  - `data.nice.status_update_at__offset` (string)

  - `data.nice.status_update_at__offset_minutes` (integer)

  - `data.nice.status_update_at__dayofweek` (string)

  - `data.nice.updated_at` (string)

  - `data.nice.updated_at__date` (string)

  - `data.nice.updated_at__time` (string)

  - `data.nice.updated_at__offset` (string)

  - `data.nice.updated_at__offset_minutes` (integer)

  - `data.nice.updated_at__dayofweek` (string)

  - `data.nice.status` (string)

  - `data.nice.status_is_public` (boolean)

  - `data.nice.status_type` (string)

  - `data.nice.user_name` (string)

  - `data.nice.has_received_invitation` (boolean)

  - `data.nice.status_color` (string)

  - `data.nice.status_lightness` (integer)

  - `data.relations` (array)

  - `data.permissions` (object)

  - `data.permissions.read` (boolean)

  - `data.permissions.update` (boolean)

  - `data.permissions.delete` (boolean)

  - `data.permissions.status_update` (boolean)

  - `data.permissions.downloadCertificate` (boolean)

  - `first_page_url` (string)

  - `from` (integer)

  - `next_page_url` (string)

  - `path` (string)

  - `per_page` (integer)

  - `prev_page_url` (string | null)

  - `to` (integer)