Gets the number of days until each person in this account is available and their availability ranges for the duration

get

https://bench.gobridgit.com/rp/api/v1/accounts/{accountId}/Persons/availabilities

Permissions
HourlyProfile: Read
Person: Read

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

int32

required

The Account ID

Query Params

relativeDate

date-time

Optional paramater used to calculate date based properties. If not provided, it is set to today's date in UTC.

start

date-time

Start date to filter availabilities from (default today UTC)

end

date-time

End date to filter availabilities to (default 10 years from today UTC)

boundRange

boolean

Defaults to true

Setting this value to true will truncate the dates returned to the specified start and end date paramters

ids

array of int64s

Optional paramater of comma delimited ids for filtering results based on the person IDs provided

ids

includeUnavailable

boolean

Defaults to false

If this is set to true it will return the availabilities and next available dates even if a person doesn't have a next availability.
If the person does not have a "nextAvailableDate", then the "availableInDays" property will be -1

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success: List of next availabilities