# List available dates.

List available dates. Availability can be listed using a specific start & end date range, or using a timeframe. When using a timeframe, the page parameter can be used to flip through weeks, months, etc.

Endpoint: GET /scheduling/available-dates
Version: 1.0.0
Security: Token

## Query parameters:

  - `filter[user_ids][]` (array)
    The IDs of users whose availability will be listed. UUID Version 4.
    Example: ["00000000-0000-4000-8000-000000000000"]

  - `filter[appointment_id]` (string)
    Appointment ID used to list availability for an existing order
    Example: "00000000-0000-4000-8000-000000000000"

  - `filter[start_at]` (string)
    Returns availability after start_at
    Example: "2021-01-01T13:00:00Z"

  - `filter[end_at]` (string)
    Returns availability before end_at
    Example: "2021-01-02T13:00:00Z"

  - `filter[timeframe]` (string)
    Returns availability for a specific timeframe. Used instead of start_at & end_at
    Enum: "DAY", "WEEK", "MONTH", "YEAR"

  - `duration` (integer)
    Duration of the event to schedule. Required if appointment_id isn't specified
    Example: 60

  - `interval` (integer)
    Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified
    Example: 15

  - `timezone` (string, required)
    The timezone of the client. Available dates results will be localized to this timezone
    Example: "CST"

  - `page` (integer)
    The requested page of results. Use this parameter to flip through pages when using the timeframe filter
    Example: 1

  - `per_page` (integer)
    The number of results per page. Only applies when using a date range
    Example: 5

## Response 200 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "success"

  - `data` (array,null)
    A collection of objects.

  - `data.date` (string, required)
    Calendar day that has available timeslots.
    Example: "2021-01-01"

  - `data.is_available` (boolean, required)
    Does the day have availability?
    Example: true

  - `meta` (object)
    Metadata about a calendar day paginated response.

  - `meta.group_id` (string,null)
    The ID of the group.
    Example: "00000000-0000-4000-8000-000000000000"

  - `meta.company_id` (string)
    The ID of the group (company).
    Example: "00000000-0000-4000-8000-000000000000"

  - `meta.company_team_member_ids` (array)
    Array of company team member IDs.
    Example: ["00000000-0000-4000-8000-000000000000"]

  - `meta.user_ids` (array)
    Array of user IDs.
    Example: ["00000000-0000-4000-8000-000000000000"]

  - `meta.appointment_id` (string,null)
    ID of the entity. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `meta.start_at` (string,null)
    Range start time.
    Example: "2021-06-30T20:30:00Z"

  - `meta.end_at` (string,null)
    Range end time.
    Example: "2021-06-30T21:30:00Z"

  - `meta.timezone` (string,null)
    The timezone.
    Example: "CST"

  - `meta.is_twilight` (boolean,null)
    Is twlight?
    Example: true

  - `meta.interval` (integer,null)
    Interval length.
    Example: 30

  - `meta.duration` (integer,null)
    Duration length.
    Example: 30

  - `meta.current_page` (integer, required)
    The current page.
    Example: 1

  - `meta.timeframe` (string,null)
    Timeframe.
    Example: "DAY"

  - `meta.timeframe_period` (object)
    Timeframe period.

  - `meta.timeframe_period.startDate` (string,null, required)
    Start date.
    Example: "2025-04-01T05:59:59.999999Z"

  - `meta.timeframe_period.endDate` (string,null, required)
    End date.
    Example: "2025-04-01T05:59:59.999999Z"

  - `meta.timeframe_period.startDateIncluded` (boolean, required)
    Start date included.
    Example: true

  - `meta.timeframe_period.endDateIncluded` (boolean, required)
    End date included.
    Example: true

  - `meta.from` (integer,null)
    The ID of the first record on this page. This is specified as either integer or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: 1

  - `meta.last_page` (integer)
    The last page of records.
    Example: 4

  - `meta.links` (array,null)
    Links.

  - `meta.links.url` (string,null, required)
    The URL of the page.
    Example: "https://admin.aryeo.test/api/v1/companies?page=2"

  - `meta.links.label` (string, required)
    The label of the page.
    Example: "2"

  - `meta.links.active` (boolean, required)
    Whether the page is active.
    Example: true

  - `meta.links.page` (integer,null)
    The page number this link points to.
    Example: 2

  - `meta.path` (string)
    The current paged path.
    Example: "https://api.aryeo.com/v1/{path}"

  - `meta.per_page` (integer)
    Number of records per page.
    Example: 15

  - `meta.to` (integer,null)
    The ID of the last record on this page. This is specified as either integer or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: 15

  - `meta.total` (integer)
    Total number of records.
    Example: 50

  - `links` (object)
    Related links for a paginated response.

  - `links.first` (string, required)
    The first page.
    Example: "https://api.aryeo.com/v1/{path}?page=1"

  - `links.last` (string, required)
    The last page.
    Example: "https://api.aryeo.com/v1/{path}?page=10"

  - `links.prev` (string,null)
    The previous page. This is specified as either string or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: "https://api.aryeo.com/v1/{path}?page=2"

  - `links.next` (string,null)
    The next page. This is specified as either string or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: "https://api.aryeo.com/v1/{path}?page=3"

  - `timestamp` (string,null)
    The request timestamp (ISO 8601).
    Example: "2021-06-30T20:30:00Z"

## Response 403 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 403

## Response 404 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 404

## Response 422 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "fail"

## Response 500 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 500