GET api/pinches/{id}
Get a Pinch by ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Pinch ID |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PinchDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| ExpirationPeriod | string |
None. |
|
| UserLimit | integer |
None. |
|
| AppTimeLimitHours | integer |
None. |
|
| ValidFrom | date |
None. |
|
| ValidTo | date |
None. |
|
| Status | PinchStatusEnum |
None. |
|
| CustomerGroup | NamedItem |
None. |
|
| Customer | NamedItem |
None. |
|
| App | AppSimpleDto |
None. |
|
| DailySchedule | Schedule |
None. |
|
| IsActive | boolean |
None. |
|
| Tags | Collection of string |
None. |
|
| PublishId | globally unique identifier |
None. |
|
| NotificationSettings | PinchNotificationDto |
None. |
|
| MessageSettings | PinchMessageSettingsDto |
None. |
|
| ModifiedDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "2f138fe5-169f-4489-88e5-13dc98765247",
"Name": "sample string 2",
"Description": "sample string 3",
"ExpirationPeriod": "sample string 4",
"UserLimit": 5,
"AppTimeLimitHours": 6,
"ValidFrom": "2026-06-11T18:48:10.286558+00:00",
"ValidTo": "2026-06-11T18:48:10.286558+00:00",
"Status": "Draft",
"CustomerGroup": {
"Id": "26c43b13-7af7-4e7f-a83c-1634c2e282d7",
"Name": "sample string 2"
},
"Customer": {
"Id": "26c43b13-7af7-4e7f-a83c-1634c2e282d7",
"Name": "sample string 2"
},
"App": {
"NotificationType": "Bubble",
"Id": "c20731aa-8be7-43f0-8757-25721e3ccd22",
"Name": "sample string 2"
},
"DailySchedule": {
"From": "sample string 1",
"To": "sample string 2"
},
"IsActive": true,
"Tags": [
"sample string 1",
"sample string 2"
],
"PublishId": "7bb2246d-d20d-4d9d-94fb-6be5ed9c4636",
"NotificationSettings": {
"BubbleImageUrl": "sample string 1",
"ShowBubble": true,
"BarImageUrl": "sample string 3",
"OpenOnAppLaunch": true,
"OpenFromNotificationCenter": true,
"OpenOnAppRunning": true,
"BubbleIconId": 1,
"BubbleTitleNo": "sample string 7",
"BubbleTitleEn": "sample string 8",
"NotificationTextNo": "sample string 9",
"NotificationTextEn": "sample string 10",
"NotificationTitleNo": "sample string 11",
"NotificationTitleEn": "sample string 12",
"TriggerNotification": "sample string 13"
},
"MessageSettings": {
"MessageTitleNo": "sample string 1",
"MessageTitleEn": "sample string 2",
"MessageTextNo": "sample string 3",
"MessageTextEn": "sample string 4",
"MessageImageUrl": "sample string 5",
"MessageType": "sample string 6"
},
"ModifiedDate": "2026-06-11T18:48:10.286558+00:00"
}