Get target groups based on ID

This API allows you to fetch all the target groups based on the target group ID.

๐Ÿ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Basic Authentication
  • Default access group

API Specification

URIv3/targetGroups/{targetGroupId}
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/v3/targetGroups/32

Request path parameters

Parameter NameData TypeDescription
targetGroupId*IntegerGroup ID of the target to retrieve

Request query parameters

Parameter NameData TypeDescription
includePeriodsBooleanBoolean flag to include target period.
https://eucrm.cc.capillarytech.com/v3/targetGroups/{targetGroupId}

Response parameters

FieldDatatypeDescription
idIntegerUnique identifier for the target group.
attribution.createdOnDate-timeCreation date and time for the target group.
attribution.lastUpdatedOnStringLast update date and time for the target group.
attribution.lastUpdatedBy.idIntegerID of the last user who updated the target group.
attribution.lastUpdatedBy.codeStringCode of the last user who updated the target group.
attribution.lastUpdatedBy.descriptionNullDescription of the last user who updated the target group.
attribution.lastUpdatedBy.nameStringName of the last user who updated the target group.
attribution.lastUpdatedBy.typeStringType of the last user who updated the target group, e.g., "ADMIN_USER".
attribution.createdBy.idIntegerID of the user who created the target group.
attribution.createdBy.codeStringCode of the user who created the target group.
attribution.createdBy.descriptionNullDescription of the user who created the target group (null).
attribution.createdBy.nameStringName of the user who created the target group.
attribution.createdBy.typeStringType of the user who created the target group, e.g., "ADMIN_USER".
nameStringName of the target group, e.g., "billExtendedFieldsTracking".
fromDateDateStart date for the target group.
toDateDateEnd date for the target group.
activeBooleanIndicates if the target group is active.
preferredTillIdIntegerPreferred till ID.
streaks[].idIntegerUnique identifier for each streak.
streaks[].targetGroupIdIntegerIdentifier linking each streak to a target group.
streaks[].nameStringName of each streak.
streaks[].targetCountOfSequenceIntegerTarget count of sequence for each streak.
activePeriod.idIntegerUnique identifier for the active period.
activePeriod.startDateDateStart date for the active period.
activePeriod.endDateDateEnd date for the active period.
activePeriod.refCodeStringReference code for the active period.
activePeriod.periodStatusStringStatus of the active period, e.g., "RUNNING".
activePeriod.targetGroupIdIntegerIdentifier linking the active period to a target group.
activePeriod.activeBooleanIndicates if the active period is active.
totalPeriodsIntegerTotal number of periods specified.
targetEvaluationTypeStringType of target evaluation, e.g., "FIXED_CALENDAR_WINDOW".
recurringCyclesIntegerNumber of recurring cycles specified (-1 for indefinite).
frequencyIntegerFrequency value set for the setting.
targetCycleStartDateDateStart date and time for the target cycle.
targetCycleEndDateDateEnd date and time for the target cycle.
frequencyTypeStringFrequency type, e.g., "QUARTERLY".
trackingTypeStringType of tracking, e.g., "STREAKS".
createdOnLongCreation timestamp for the setting.
{
    "data": {
        "id": 1253,
        "attribution": {
            "createdOn": "2023-08-29T07:18:49.000+0000",
            "lastUpdatedOn": "2023-08-29T07:18:49.000+0000",
            "lastUpdatedBy": {
                "id": 4,
                "code": "First",
                "description": null,
                "name": "First User",
                "type": "ADMIN_USER"
            },
            "createdBy": {
                "id": 4,
                "code": "First",
                "description": null,
                "name": "First User",
                "type": "ADMIN_USER"
            }
        },
        "name": "billExtendedFieldsTracking",
        "fromDate": "2023-08-29",
        "toDate": "2023-11-28",
        "active": true,
        "preferredTillId": 50674058,
        "streaks": [
            {
                "id": 1,
                "attribution": {
                    "createdOn": null,
                    "lastUpdatedOn": null,
                    "lastUpdatedBy": {
                        "id": 4,
                        "code": "First",
                        "description": null,
                        "name": "First User",
                        "type": "ADMIN_USER"
                    },
                    "createdBy": {
                        "id": 4,
                        "code": "First",
                        "description": null,
                        "name": "First User",
                        "type": "ADMIN_USER"
                    }
                },
                "targetGroupId": 1253,
                "name": "streaks_dummy",
                "targetCountOfSequence": 1
            },
            {
                "id": 2,
                "attribution": {
                    "createdOn": null,
                    "lastUpdatedOn": null,
                    "lastUpdatedBy": {
                        "id": 4,
                        "code": "First",
                        "description": null,
                        "name": "First User",
                        "type": "ADMIN_USER"
                    },
                    "createdBy": {
                        "id": 4,
                        "code": "First",
                        "description": null,
                        "name": "First User",
                        "type": "ADMIN_USER"
                    }
                },
                "targetGroupId": 1253,
                "name": "streaks_dummy2",
                "targetCountOfSequence": 1
            }
        ],
        "activePeriod": {
            "id": 1743,
            "attribution": {
                "createdOn": "2023-08-29T07:18:49.000+0000",
                "lastUpdatedOn": "2023-08-29T07:18:49.000+0000",
                "lastUpdatedBy": {
                    "id": 4,
                    "code": "First",
                    "description": null,
                    "name": "First User",
                    "type": "ADMIN_USER"
                },
                "createdBy": {
                    "id": 4,
                    "code": "First",
                    "description": null,
                    "name": "First User",
                    "type": "ADMIN_USER"
                }
            },
            "startDate": "2023-08-29",
            "endDate": "2023-11-28",
            "refCode": "p1",
            "periodStatus": "RUNNING",
            "targetGroupId": 1253,
            "active": true
        },
        "totalPeriods": 1,
        "targetEvaluationType": "FIXED_CALENDAR_WINDOW",
        "recurringCycles": -1,
        "frequency": 0,
        "targetCycleStartDate": "2023-08-29T00:00:00.000Z",
        "targetCycleEndDate": "2023-11-28T23:59:59.000Z",
        "frequencyType": "QUARTERLY",
        "trackingType": "STREAKS",
        "createdOn": 1693293529000
    },
    "errors": null,
    "warnings": null
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!