Availabilities

Get Availabilities

Get existing availabilities from your Papershift account

URL

https://app.papershift.com/public_api/v1/availabilities

Method

GET

Parameters

Parameter	Type	Requiered
api_token	String	required
user_id	Integer	required
user_external_id	String	required if user_id not set
start_date	String	required
end_date	String	required
page	Integer	optional

Information

A successful request returns all availability entries associated with the provided date filter inputs.

Example

{
  "api_token" : "6ooIiSZaiBwaFBLxveJkm7pP8uTOPLPSwDL6QsOK",
  "user_id": 1,
  "start_date": "2017-01-01",
  "end_date": "2017-12-31",
  "page": 2
}

function getTargetHours() {
  $.ajax({
    url: "https://app.papershift.com/public_api/v1/availabilities?api_token=6ooIiSZaiBwaFBLxveJkm7pP8uTOPLPSwDL6QsOK&user_id=1&start_date=2017-01-01&end_date=2017-12-31&page=2",
    type: 'GET',
    dataType: 'json',
    data: JSON.stringify(params),
    complete: function (data) {
      console.log(data.responseText);
    }
  });
}

{
    "availabilities": [
        {
            "id": 1379939,
            "starts_at": "2025-03-17T01:00:00Z",
            "ends_at": "2025-03-17T12:00:00Z",
            "created_at": "2025-03-19T08:17:32Z",
            "updated_at": "2025-03-19T08:17:32Z",
            "status": "active",
            "import_id": null,
            "user_id": 6887
        },
        {
            "id": 1379940,
            "starts_at": "2025-03-18T02:00:00Z",
            "ends_at": "2025-03-18T07:00:00Z",
            "created_at": "2025-03-19T08:17:33Z",
            "updated_at": "2025-03-19T08:17:33Z",
            "status": "active",
            "import_id": null,
            "user_id": 6887
        }
    ],
    "page_number": 1,
    "total_pages": 1,
    "next_page": null
}