Profiles

get
Responses
200Success
application/json
get
GET /v1/crm/profiles HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "sequence": 1,
        "number": "text",
        "joiningDate": "text",
        "workEmail": "text",
        "internalNote": "text",
        "pointsAvailable": 1,
        "pointsPending": 1,
        "pointsOnhold": 1,
        "id": "text"
      }
    ]
  }
}
get
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /v1/crm/profiles/{id} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "sequence": 1,
      "number": "text",
      "joiningDate": "text",
      "workEmail": "text",
      "internalNote": "text",
      "pointsAvailable": 1,
      "pointsPending": 1,
      "pointsOnhold": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "id": "text",
      "level": {
        "locales": {},
        "sortNumber": 1,
        "alias": "text",
        "rewardQualPoints": 1,
        "rewardQualPeriod": {},
        "rewardRetention": {},
        "pointsConvertRate": 1,
        "rewardValidaty": {},
        "id": "text",
        "benefits": [
          {
            "locales": {},
            "type": 1,
            "amount": 1,
            "discountRef": "text",
            "sortNumber": 1,
            "id": "text",
            "uid": "text",
            "rules": [
              {
                "conditions": [
                  {
                    "key": "basic.date",
                    "operator": "contains",
                    "value": "text"
                  }
                ],
                "action": 1,
                "sortNumber": 1,
                "id": "text",
                "uid": "text",
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text"
              }
            ],
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "applicable": true,
            "overwritten": true
          }
        ]
      },
      "enrollments": [
        {
          "startTime": "text",
          "endTime": "text",
          "ended": true,
          "endedAt": "text",
          "id": "text",
          "program": {
            "locales": {},
            "excludedLevels": {},
            "period": 1,
            "periodUnit": {},
            "alias": "text",
            "id": "text",
            "benefits": [
              {
                "locales": {},
                "type": 1,
                "amount": 1,
                "discountRef": "text",
                "sortNumber": 1,
                "id": "text",
                "uid": "text",
                "rules": [
                  {
                    "conditions": [
                      {
                        "key": "basic.date",
                        "operator": "contains",
                        "value": "text"
                      }
                    ],
                    "action": 1,
                    "sortNumber": 1,
                    "id": "text",
                    "uid": "text",
                    "createdAt": "text",
                    "createdVia": "text",
                    "createdBy": "text",
                    "updatedAt": "text",
                    "updatedVia": "text",
                    "updatedBy": "text"
                  }
                ],
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "isEffective": true,
                "effectiveStartTime": "text",
                "effectiveEndTime": "text",
                "applicable": true,
                "overwritten": true
              }
            ]
          }
        }
      ],
      "partners": [
        {
          "domain": "text",
          "locales": {},
          "id": "text",
          "programs": [
            {
              "locales": {},
              "excludedLevels": {},
              "period": 1,
              "periodUnit": {},
              "alias": "text",
              "id": "text",
              "benefits": [
                {
                  "locales": {},
                  "type": 1,
                  "amount": 1,
                  "discountRef": "text",
                  "sortNumber": 1,
                  "id": "text",
                  "uid": "text",
                  "rules": [
                    {
                      "conditions": [
                        {
                          "key": "basic.date",
                          "operator": "contains",
                          "value": "text"
                        }
                      ],
                      "action": 1,
                      "sortNumber": 1,
                      "id": "text",
                      "uid": "text",
                      "createdAt": "text",
                      "createdVia": "text",
                      "createdBy": "text",
                      "updatedAt": "text",
                      "updatedVia": "text",
                      "updatedBy": "text"
                    }
                  ],
                  "createdAt": "text",
                  "createdVia": "text",
                  "createdBy": "text",
                  "updatedAt": "text",
                  "updatedVia": "text",
                  "updatedBy": "text"
                }
              ]
            }
          ]
        }
      ],
      "tagAssignments": [
        {
          "eligible": true,
          "effectiveStartTime": "text",
          "effectiveEndTime": "text",
          "attrs": {},
          "uid": "text",
          "tagUid": "text",
          "customerUid": "text",
          "effective": true,
          "tag": {
            "type": 1,
            "locales": {},
            "sortBy": "text",
            "uid": "text",
            "dataModelUids": [
              "text"
            ],
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text"
          },
          "benefits": [
            {
              "locales": {},
              "type": 1,
              "amount": 1,
              "discountRef": "text",
              "sortNumber": 1,
              "id": "text",
              "uid": "text",
              "rules": [
                {
                  "conditions": [
                    {
                      "key": "basic.date",
                      "operator": "contains",
                      "value": "text"
                    }
                  ],
                  "action": 1,
                  "sortNumber": 1,
                  "id": "text",
                  "uid": "text",
                  "createdAt": "text",
                  "createdVia": "text",
                  "createdBy": "text",
                  "updatedAt": "text",
                  "updatedVia": "text",
                  "updatedBy": "text"
                }
              ],
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "applicable": true,
              "overwritten": true
            }
          ],
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text"
        }
      ]
    }
  }
}

Was this helpful?