Create time period

Creates a time period. start_date/end_date accept YYYY-MM-DD (datetimes are truncated to their date). is_current is ignored on input and derived on read. Returns 409 when it overlaps an existing period; periods that touch (one's end_date equals the next's start_date) are allowed. end_date is exclusive: the first day after the period (a period covering Aug 16–22 has end_date 2026-08-23).

RBAC · time_sheet

Request body

Content type: application/json · schema WorkV1CreateTimePeriodBody

start_dateanyOfRequired

anyOf (option 1)string

pattern /^\d{4}-\d{2}-\d{2}$/

anyOf (option 2)string <date-time>

end_dateanyOfRequired

Exclusive end of the period: the first day after the period. A period covering Aug 16–22 has end_date 2026-08-23.

anyOf (option 1)string

pattern /^\d{4}-\d{2}-\d{2}$/

anyOf (option 2)string <date-time>

is_currentboolean

Ignored. is_current is derived from the dates on read; accepted for backward compatibility.

Response body

Success response 200 · schema WorkV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Operation succeeded.

201

Create-like operation succeeded.

400

Validation or request parsing failure.

401

API key missing/invalid or associated user missing.

403

RBAC denied for time_sheet resource action.

409

Conflict: the period overlaps an existing period, is closed (reopen it first), or has time sheets that block the change.

500

Unexpected controller/service failure.

POST /api/v1/time-periods

cURL

curl -X POST "https://algapsa.com/api/v1/time-periods" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_date": "",
  "end_date": "",
  "is_current": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/time-periods", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "start_date": "",
    "end_date": "",
    "is_current": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/time-periods");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""start_date"": """",
  ""end_date"": """",
  ""is_current"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}