Back to endpoints

Get All Staff member availabilities in an organization

GET api/V3/{language}/org/{orgIdentifier}/staff/availabilities

?page={page}

&perPage={perPage}

&from={from}

&to={to}

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

 Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
page (integer)

Result page number that appears first.

Default value is 1

 Optional
perPage (integer)

Number of results per page.

Default value is 200

 Optional
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Staff (StaffSummaryApiModelV3)

Object containing staff id, first name, last name and state
Availability (AvailabilityPatternApiModelV3)

Response Formats

CODE SAMPLE JSON 
[
  {
    "Staff": {
      "Object": "Person",
      "Id": 1,
      "FirstName": "Daniel",
      "LastName": "Naroditsky",
      "State": "Normal"
    },
    "Availability": {
      "Id": 2,
      "AvailableDays": [
        {
          "DayOfWeek": "Monday",
          "Times": [
            {
              "Id": null,
              "StartTime": "18:00:00",
              "EndTime": "19:00:00"
            }
          ]
        },
        {
          "DayOfWeek": "Thursday",
          "Times": [
            {
              "Id": null,
              "StartTime": "18:00:00",
              "EndTime": "19:00:00"
            }
          ]
        }
      ],
      "Name": "On Call Period",
      "StartDate": "2022-01-01T00:00:00",
      "EndDate": "2022-12-31T00:00:00"
    }
  },
  {
    "Staff": {
      "Id": 1,
      "FirstName": "Daniel",
      "LastName": "Naroditsky",
      "State": "Normal"
    },
    "Availability": {
      "Id": 2,
      "AvailableDays": [
        {
          "DayOfWeek": "Monday",
          "Times": [
            {
              "Id": null,
              "StartTime": "18:00:00",
              "EndTime": "19:00:00"
            }
          ]
        },
        {
          "DayOfWeek": "Thursday",
          "Times": [
            {
              "Id": null,
              "StartTime": "18:00:00",
              "EndTime": "19:00:00"
            }
          ]
        }
      ],
      "Name": "On Call Period",
      "StartDate": "2022-01-01T00:00:00",
      "EndDate": "2022-12-31T00:00:00"
    }
  }
]