> For the complete documentation index, see [llms.txt](https://docs.fieldmotion.com/fieldmotion-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fieldmotion.com/fieldmotion-api-docs/availability/_list.md).

# \_list

Returns the data of selected Availabilities depending on filter parameters. Will return all of them if no parameters are used.

### Parameters

#### id

The ID of an exact Availability.

#### from

Sets a point in epoch time. This filter only allows Availabilities that end past this point.

#### to

Sets a point in epoch time. This filter only allows Availabilities that start before this point.

#### obj\_type

The sort of object which this Availability will affect, being a Company, Department, Role or User.

* company
* department
* role
* user

#### obj\_id

The type of event in relation to the Availability, can be one of the following:

* absence
* annual\_leave
* sick\_leave
* unpaid\_leave
* public\_holiday
* company\_holiday
* unavailable
* available\_override

#### status

The Status of the Availability:\
0 = Pending\
1 = Approved\
2 = Rejected\
3 = Cancelled

### Example

```
FM_api('Availability_list',[
  'from' => '1781607600',
  'to' => '1781866800'
  ]
);
```

### Result

```
[{"id":60004,"obj_type":"department","obj_id":2,"event_type":"unpaid_leave","availability":1,"status":3,"status_name":"cancelled","name":"The Big Day","start_e":1781823600,"end_e":1781910000,"all_day":1,"paid":1,"requested_by":113747,"approved_by":113747,"approved_at":1781700745,"notes":"test availability","meta":[],"cdate":1781616860,"last_edited":1781702071,"created_by":113747},{"id":30003,"obj_type":"user","obj_id":113747,"event_type":"available_override","availability":1,"status":2,"status_name":"rejected","name":"test availability","start_e":1781823600,"end_e":1781910000,"all_day":1,"paid":1,"requested_by":113747,"approved_by":0,"approved_at":0,"notes":"test availability","meta":[],"cdate":1781691589,"last_edited":1781702053,"created_by":113747},{"id":30001,"obj_type":"user","obj_id":113747,"event_type":"available_override","availability":1,"status":3,"status_name":"cancelled","name":"test availability","start_e":1781823600,"end_e":1781910000,"all_day":1,"paid":1,"requested_by":113747,"approved_by":0,"approved_at":0,"notes":"test availability","meta":[],"cdate":1781616047,"last_edited":1781702061,"created_by":113747},{"id":60003,"obj_type":"department","obj_id":2,"event_type":"annual_leave","availability":0,"status":0,"status_name":"pending","name":"dss","start_e":1781564400,"end_e":1781650800,"all_day":1,"paid":1,"requested_by":113747,"approved_by":0,"approved_at":0,"notes":"","meta":[],"cdate":1781616815,"last_edited":1781616815,"created_by":113747},{"id":60002,"obj_type":"department","obj_id":1,"event_type":"annual_leave","availability":0,"status":0,"status_name":"pending","name":"dss","start_e":1781564400,"end_e":1781650800,"all_day":1,"paid":1,"requested_by":113747,"approved_by":0,"approved_at":0,"notes":"","meta":[],"cdate":1781616369,"last_edited":1781616815,"created_by":113747},{"id":60001,"obj_type":"user","obj_id":113747,"event_type":"annual_leave","availability":0,"status":1,"status_name":"approved","name":"","start_e":1781564400,"end_e":1781650800,"all_day":1,"paid":1,"requested_by":113747,"approved_by":113747,"approved_at":1782808912,"notes":"mm","meta":[],"cdate":1781616243,"last_edited":1782808912,"created_by":113747},{"id":30002,"obj_type":"role","obj_id":1,"event_type":"annual_leave","availability":0,"status":0,"status_name":"pending","name":"wha","start_e":1781564400,"end_e":1781650800,"all_day":1,"paid":1,"requested_by":113747,"approved_by":0,"approved_at":0,"notes":"aaaa","meta":[],"cdate":1781616217,"last_edited":1782200239,"created_by":113747}]
```