Get target periods

This API is used to fetch all target periods present in a target group. Meaning, this depends on the "target group id" and that is a mandatory parameter.

Please click on the 200 symbol to see sample 200 response.

API endpoint example

https://eu.api.capillarytech.com/v3/targetGroups/2163/targetPeriods

curl --location 'https://eu.api.capillarytech.com/v3/targetGroups/2163/targetPeriods' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJ5OjVjMTc' \
--header 'Cookie: _cfuvid=Hz5vxex9nxE.gNjvnTwDBDgfNLFEoicCUfrgNIeurLY-1750403636294-0.0.1.1-604800000'

Response parameter

ParameterTypeDescription
dataArrayList of objects containing the main data payload.
data[].idIntegerUnique identifier for the record.
data[].attributionObjectMetadata about the creation and updates of the record.
attribution.createdOnStringTimestamp when the record was created (ISO 8601 format).
attribution.lastUpdatedOnStringTimestamp when the record was last updated (ISO 8601 format).
attribution.lastUpdatedByObjectDetails of the user who last updated the record.
lastUpdatedBy.idIntegerUnique identifier of the user.
lastUpdatedBy.codeStringCode associated with the user.
lastUpdatedBy.descriptionStringDescription of the user
lastUpdatedBy.nameStringName of the user.
lastUpdatedBy.typeStringType of the user (e.g., "TILL").
attribution.createdByObjectDetails of the user who created the record (same structure as lastUpdatedBy).
data[].startDateStringStart date of the period (YYYY-MM-DD format).
data[].endDateStringEnd date of the period (YYYY-MM-DD format).
data[].refCodeStringReference code for the period (e.g., "Cycle_1").
data[].periodStatusStringStatus of the period (e.g., "ENDED").
data[].targetGroupIdIntegerIdentifier for the target group associated with the period.
data[].descriptionStringDescription of the period (empty in this case).
data[].activeBooleanIndicates whether the period is active.
{
    "data": [
        {
            "id": 19336,
            "attribution": {
                "createdOn": "2025-05-22T03:43:09.000+0000",
                "lastUpdatedOn": "2025-05-22T03:43:09.000+0000",
                "lastUpdatedBy": {
                    "id": 75155297,
                    "code": "tj_capillary",
                    "description": "",
                    "name": "tj_capillary",
                    "type": "TILL"
                },
                "createdBy": {
                    "id": 75155297,
                    "code": "tj_capillary",
                    "description": "",
                    "name": "tj_capillary",
                    "type": "TILL"
                }
            },
            "startDate": "2025-05-22",
            "endDate": "2025-05-22",
            "refCode": "Cycle_1",
            "periodStatus": "ENDED",
            "targetGroupId": 2163,
            "description": "",
            "active": true
        },
        {
            "id": 19337,
            "attribution": {
                "createdOn": "2025-05-22T03:43:09.000+0000",
                "lastUpdatedOn": "2025-05-22T03:43:09.000+0000",
                "lastUpdatedBy": {
                    "id": 75155297,
                    "code": "tj_capillary",
                    "description": "",
                    "name": "tj_capillary",
                    "type": "TILL"
                },
                "createdBy": {
                    "id": 75155297,
                    "code": "tj_capillary",
                    "description": "",
                    "name": "tj_capillary",
                    "type": "TILL"
                }
            },
            "startDate": "2025-05-23",
            "endDate": "2025-05-23",
            "refCode": "Cycle_2",
            "periodStatus": "ENDED",
            "targetGroupId": 2163,
            "description": "",
            "active": true
        }
    ],
    "errors": null,
    "warnings": null
}
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!