Skip to main content
GET
/
availability
/
get-availability
Get Availability
curl --request GET \
  --url http://localhost:3000/api/availability/get-availability
{
  "artistId": "<string>",
  "availabilityId": "<string>",
  "isActive": true,
  "weeklySlots": {},
  "dateRangeType": "indefinitely",
  "effectiveFrom": 123,
  "createdAt": 123,
  "updatedAt": 123,
  "effectiveUntil": 123,
  "rollingDays": "<string>"
}

Query Parameters

​
artistId
string
required

The ID of the artist

Response

200 - application/json

Availability retrieved successfully

​
artistId
string
required

ID of the artist this availability belongs to

​
availabilityId
string
required

Unique identifier for this availability

​
isActive
boolean
required

Whether this availability is currently active

​
weeklySlots
object
required

Weekly schedule with days as keys (e.g., 'Sunday', 'Monday')

​
dateRangeType
enum<string>
required

Type of date range for this availability

Available options:
indefinitely,
specific,
rolling
​
effectiveFrom
number
required

UTC timestamp in milliseconds when this availability becomes effective

​
createdAt
number
required

UTC timestamp in milliseconds when this availability was created

​
updatedAt
number
required

UTC timestamp in milliseconds when this availability was last updated

​
effectiveUntil
number

Optional UTC timestamp in milliseconds when this availability ends

​
rollingDays
string

Optional number of days to roll over when dateRangeType is 'rolling'