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": "6a533c7c-9762-4eba-ac7c-fd726b6d8028",
"Name": "sample string 2",
"Description": "sample string 3",
"ExpirationPeriod": "sample string 4",
"UserLimit": 5,
"AppTimeLimitHours": 6,
"ValidFrom": "2026-04-18T01:57:02.0761792+00:00",
"ValidTo": "2026-04-18T01:57:02.0761792+00:00",
"Status": "Draft",
"CustomerGroup": {
"Id": "ce9b77ef-c8a1-4b97-b9dc-27fc9d1e7b1a",
"Name": "sample string 2"
},
"Customer": {
"Id": "ce9b77ef-c8a1-4b97-b9dc-27fc9d1e7b1a",
"Name": "sample string 2"
},
"App": {
"NotificationType": "Bubble",
"Id": "1927f7e6-0f0c-43d4-91da-841cf4d571e5",
"Name": "sample string 2"
},
"DailySchedule": {
"From": "sample string 1",
"To": "sample string 2"
},
"IsActive": true,
"Tags": [
"sample string 1",
"sample string 2"
],
"PublishId": "2df95622-1d4c-4664-8476-db312080bbe2",
"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-04-18T01:57:02.0761792+00:00"
}