LoginStart for Free

Support Hours

List support hours.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters
start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 50Optional

the maximum number of results when paging through a list of support hours.

Default: 50
Responses
200

list of support hours

application/json
get
/support-hours
GET /api/support-hours HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

list of support hours

[
  {
    "id": 1,
    "name": "text",
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "timezone": "Europe/Berlin",
    "supportDays": {
      "MONDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      },
      "TUESDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      },
      "WEDNESDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      },
      "THURSDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      },
      "FRIDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      },
      "SATURDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      },
      "SUNDAY": {
        "start": "23:17:28",
        "end": "23:17:28"
      }
    }
  }
]

Create a new support hour.

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Body
idinteger · int64Optional
namestringRequired
timezonestring · enumRequiredPossible values:
Responses
post
/support-hours
POST /api/support-hours HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "TUESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "WEDNESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "THURSDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "FRIDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SATURDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SUNDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    }
  }
}
201

the response

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "TUESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "WEDNESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "THURSDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "FRIDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SATURDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SUNDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    }
  }
}

Get the support hour with specified id.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Responses
200

the support hour object

application/json
get
/support-hours/{id}
GET /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the support hour object

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "TUESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "WEDNESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "THURSDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "FRIDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SATURDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SUNDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    }
  }
}

Update an existing support hour.

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Body
idinteger · int64Optional
namestringRequired
timezonestring · enumRequiredPossible values:
Responses
200

the updated support hour object

application/json
put
/support-hours/{id}
PUT /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "TUESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "WEDNESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "THURSDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "FRIDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SATURDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SUNDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    }
  }
}
200

the updated support hour object

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "TUESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "WEDNESDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "THURSDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "FRIDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SATURDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    },
    "SUNDAY": {
      "start": "23:17:28",
      "end": "23:17:28"
    }
  }
}

Delete the specified support hour.

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Responses
delete
/support-hours/{id}
DELETE /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content
PreviousAlert ActionsNextConnectors

Last updated

Was this helpful?