Progress API: Periods

Retrieves one specific period

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

periodstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/progress/periods/{period}

HTTPcURLJavaScriptPython

GET /v2/e01/api/progress/periods/{period} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodId": "123e4567-e89b-12d3-a456-426614174000",
  "periodName": "text",
  "periodEnd": "2026-01-29T16:19:39.796Z",
  "periodStart": "2026-01-29T16:19:39.796Z"
}

Checks for the existence of one specific period

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

periodstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/progress/periods/{period}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/progress/periods/{period} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

namestring · nullableOptional

endBeforestring · date-time · nullableOptional

endSincestring · date-time · nullableOptional

startBeforestring · date-time · nullableOptional

startSincestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/progress/periods/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/periods/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 668

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:19:39.796Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "endBefore": "2026-01-29T16:19:39.796Z",
  "endSince": "2026-01-29T16:19:39.796Z",
  "startBefore": "2026-01-29T16:19:39.796Z",
  "startSince": "2026-01-29T16:19:39.796Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "periodId": "123e4567-e89b-12d3-a456-426614174000",
    "periodName": "text",
    "periodEnd": "2026-01-29T16:19:39.796Z",
    "periodStart": "2026-01-29T16:19:39.796Z"
  }
]

Counts the periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

namestring · nullableOptional

endBeforestring · date-time · nullableOptional

endSincestring · date-time · nullableOptional

startBeforestring · date-time · nullableOptional

startSincestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/progress/periods/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/periods/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 668

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:19:39.796Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "endBefore": "2026-01-29T16:19:39.796Z",
  "endSince": "2026-01-29T16:19:39.796Z",
  "startBefore": "2026-01-29T16:19:39.796Z",
  "startSince": "2026-01-29T16:19:39.796Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

namestring · nullableOptional

endBeforestring · date-time · nullableOptional

endSincestring · date-time · nullableOptional

startBeforestring · date-time · nullableOptional

startSincestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/progress/periods/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/periods/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 668

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:19:39.796Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "endBefore": "2026-01-29T16:19:39.796Z",
  "endSince": "2026-01-29T16:19:39.796Z",
  "startBefore": "2026-01-29T16:19:39.796Z",
  "startSince": "2026-01-29T16:19:39.796Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

namestring · nullableOptional

endBeforestring · date-time · nullableOptional

endSincestring · date-time · nullableOptional

startBeforestring · date-time · nullableOptional

startSincestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/progress/periods/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/periods/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 668

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:19:39.796Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "endBefore": "2026-01-29T16:19:39.796Z",
  "endSince": "2026-01-29T16:19:39.796Z",
  "startBefore": "2026-01-29T16:19:39.796Z",
  "startSince": "2026-01-29T16:19:39.796Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
]