GET api/Folders/{id}?userId={userId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | string |
Required |
|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Folder| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| AccountId | integer |
None. |
|
| Api | string |
None. |
|
| HookupId | string |
None. |
|
| Name | string |
None. |
|
| Type | FolderType |
None. |
|
| Snippet | string |
None. |
|
| CreateDate | date |
None. |
|
| LastModified | date |
None. |
|
| ParentId | integer |
None. |
|
| Status | string |
None. |
|
| StartDate | date |
None. |
|
| Location | string |
None. |
|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| EndDate | date |
None. |
|
| Galleries | Collection of Gallery |
None. |
|
| Contacts | Collection of Contact |
None. |
|
| Notifications | Collection of Notification |
None. |
|
| Documents | Collection of Document |
None. |
|
| SubFolders | Collection of Folder |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"AccountId": 2,
"Api": "sample string 3",
"HookupId": "sample string 4",
"Name": "sample string 5",
"Type": 0,
"Snippet": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"LastModified": "2025-07-18T12:48:27.203927+00:00",
"ParentId": 7,
"Status": "sample string 8",
"StartDate": "2025-07-18T12:48:27.203927+00:00",
"Location": "sample string 9",
"Latitude": 1.1,
"Longitude": 1.1,
"EndDate": "2025-07-18T12:48:27.203927+00:00",
"Galleries": [
{
"Id": 1,
"AccountId": 2,
"FolderId": 3,
"FolderName": "sample string 4",
"Api": "sample string 5",
"HookupId": "sample string 6",
"Name": "sample string 7",
"Status": 0,
"Snippet": "sample string 8",
"Location": "sample string 9",
"Latitude": 1.1,
"Longitude": 1.1,
"StartDateTime": "2025-07-18T12:48:27.203927+00:00",
"EndDateTime": "2025-07-18T12:48:27.203927+00:00",
"AuthToken": "sample string 10",
"Siblings": [
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
},
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
}
],
"FacialIndexes": [
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
},
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
}
],
"Photos": [
{
"Id": 1,
"GalleryId": 2,
"UserId": "sample string 3",
"Bucket": "sample string 4",
"Folder": "sample string 5",
"FileName": "sample string 6",
"Height": 7,
"Width": 8,
"Orientation": 9,
"Latitude": 1.1,
"Longitude": 1.1,
"TimeTaken": "2025-07-18T12:48:27.203927+00:00",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"Sorts": [
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
},
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
}
],
"Url": "sample string 10",
"OriginalUrl": "sample string 11",
"HookupId": "sample string 12",
"Status": 0
},
{
"Id": 1,
"GalleryId": 2,
"UserId": "sample string 3",
"Bucket": "sample string 4",
"Folder": "sample string 5",
"FileName": "sample string 6",
"Height": 7,
"Width": 8,
"Orientation": 9,
"Latitude": 1.1,
"Longitude": 1.1,
"TimeTaken": "2025-07-18T12:48:27.203927+00:00",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"Sorts": [
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
},
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
}
],
"Url": "sample string 10",
"OriginalUrl": "sample string 11",
"HookupId": "sample string 12",
"Status": 0
}
],
"Sorts": [
{
"HookupId": "sample string 1",
"SortName": "sample string 2",
"SortType": 0,
"SortStatus": 0,
"Count": 3
},
{
"HookupId": "sample string 1",
"SortName": "sample string 2",
"SortType": 0,
"SortStatus": 0,
"Count": 3
}
],
"SortFilters": [
{
"Id": 1,
"TagTypes": [
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
},
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
}
],
"TextOnly": true,
"NumericOnly": true,
"Confidence": 2.1,
"MinLength": 3,
"MaxLength": 4,
"StartsWith": "sample string 5",
"EndsWith": "sample string 6",
"Matches": "sample string 7",
"Exclude": "sample string 8",
"OrderBy": "sample string 9",
"OutputFormat": "sample string 10",
"GalleryId": 11
},
{
"Id": 1,
"TagTypes": [
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
},
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
}
],
"TextOnly": true,
"NumericOnly": true,
"Confidence": 2.1,
"MinLength": 3,
"MaxLength": 4,
"StartsWith": "sample string 5",
"EndsWith": "sample string 6",
"Matches": "sample string 7",
"Exclude": "sample string 8",
"OrderBy": "sample string 9",
"OutputFormat": "sample string 10",
"GalleryId": 11
}
],
"Documents": [
{
"Id": 1,
"GalleryId": 1,
"UserId": "sample string 2",
"Bucket": "sample string 3",
"Folder": "sample string 4",
"FileName": "sample string 5",
"Status": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"FolderId": 1,
"DocumentType": 0
},
{
"Id": 1,
"GalleryId": 1,
"UserId": "sample string 2",
"Bucket": "sample string 3",
"Folder": "sample string 4",
"FileName": "sample string 5",
"Status": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"FolderId": 1,
"DocumentType": 0
}
]
},
{
"Id": 1,
"AccountId": 2,
"FolderId": 3,
"FolderName": "sample string 4",
"Api": "sample string 5",
"HookupId": "sample string 6",
"Name": "sample string 7",
"Status": 0,
"Snippet": "sample string 8",
"Location": "sample string 9",
"Latitude": 1.1,
"Longitude": 1.1,
"StartDateTime": "2025-07-18T12:48:27.203927+00:00",
"EndDateTime": "2025-07-18T12:48:27.203927+00:00",
"AuthToken": "sample string 10",
"Siblings": [
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
},
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
}
],
"FacialIndexes": [
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
},
{
"GalleryId": "sample string 1",
"Name": "sample string 2",
"Api": "sample string 3",
"FolderId": "sample string 4"
}
],
"Photos": [
{
"Id": 1,
"GalleryId": 2,
"UserId": "sample string 3",
"Bucket": "sample string 4",
"Folder": "sample string 5",
"FileName": "sample string 6",
"Height": 7,
"Width": 8,
"Orientation": 9,
"Latitude": 1.1,
"Longitude": 1.1,
"TimeTaken": "2025-07-18T12:48:27.203927+00:00",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"Sorts": [
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
},
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
}
],
"Url": "sample string 10",
"OriginalUrl": "sample string 11",
"HookupId": "sample string 12",
"Status": 0
},
{
"Id": 1,
"GalleryId": 2,
"UserId": "sample string 3",
"Bucket": "sample string 4",
"Folder": "sample string 5",
"FileName": "sample string 6",
"Height": 7,
"Width": 8,
"Orientation": 9,
"Latitude": 1.1,
"Longitude": 1.1,
"TimeTaken": "2025-07-18T12:48:27.203927+00:00",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"Sorts": [
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
},
{
"Id": 1,
"PhotoId": 2,
"SortType": 0,
"HookupId": "sample string 3",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"Status": 0
}
],
"Url": "sample string 10",
"OriginalUrl": "sample string 11",
"HookupId": "sample string 12",
"Status": 0
}
],
"Sorts": [
{
"HookupId": "sample string 1",
"SortName": "sample string 2",
"SortType": 0,
"SortStatus": 0,
"Count": 3
},
{
"HookupId": "sample string 1",
"SortName": "sample string 2",
"SortType": 0,
"SortStatus": 0,
"Count": 3
}
],
"SortFilters": [
{
"Id": 1,
"TagTypes": [
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
},
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
}
],
"TextOnly": true,
"NumericOnly": true,
"Confidence": 2.1,
"MinLength": 3,
"MaxLength": 4,
"StartsWith": "sample string 5",
"EndsWith": "sample string 6",
"Matches": "sample string 7",
"Exclude": "sample string 8",
"OrderBy": "sample string 9",
"OutputFormat": "sample string 10",
"GalleryId": 11
},
{
"Id": 1,
"TagTypes": [
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
},
{
"Id": 1,
"TagType": 0,
"SortFilterId": 2
}
],
"TextOnly": true,
"NumericOnly": true,
"Confidence": 2.1,
"MinLength": 3,
"MaxLength": 4,
"StartsWith": "sample string 5",
"EndsWith": "sample string 6",
"Matches": "sample string 7",
"Exclude": "sample string 8",
"OrderBy": "sample string 9",
"OutputFormat": "sample string 10",
"GalleryId": 11
}
],
"Documents": [
{
"Id": 1,
"GalleryId": 1,
"UserId": "sample string 2",
"Bucket": "sample string 3",
"Folder": "sample string 4",
"FileName": "sample string 5",
"Status": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"FolderId": 1,
"DocumentType": 0
},
{
"Id": 1,
"GalleryId": 1,
"UserId": "sample string 2",
"Bucket": "sample string 3",
"Folder": "sample string 4",
"FileName": "sample string 5",
"Status": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"FolderId": 1,
"DocumentType": 0
}
]
}
],
"Contacts": [
{
"Id": 1,
"DocumentId": 2,
"FolderId": 1,
"Tag": "sample string 3",
"Email": "sample string 4",
"Email2": "sample string 5",
"Name": "sample string 6",
"First": "sample string 7",
"Last": "sample string 8",
"Phone": "sample string 9",
"School": "sample string 10",
"Class": "sample string 11",
"Grade": "sample string 12",
"PassCode": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Link": "sample string 16",
"Filename": "sample string 17",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"ContactNotifications": [
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Notification": {
"Id": 1,
"FolderId": 2,
"Type": 0,
"From": "sample string 3",
"To": "sample string 4",
"Subject": "sample string 5",
"Message": "sample string 6",
"Status": "sample string 7",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"SendDateTime": "2025-07-18T12:48:27.203927+00:00",
"ProcessDateTime": "2025-07-18T12:48:27.203927+00:00",
"WithPhotos": true,
"WithoutPhotos": true,
"NoClicks": true,
"ContactNotifications": []
}
},
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Notification": {
"Id": 1,
"FolderId": 2,
"Type": 0,
"From": "sample string 3",
"To": "sample string 4",
"Subject": "sample string 5",
"Message": "sample string 6",
"Status": "sample string 7",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"SendDateTime": "2025-07-18T12:48:27.203927+00:00",
"ProcessDateTime": "2025-07-18T12:48:27.203927+00:00",
"WithPhotos": true,
"WithoutPhotos": true,
"NoClicks": true,
"ContactNotifications": []
}
}
]
},
{
"Id": 1,
"DocumentId": 2,
"FolderId": 1,
"Tag": "sample string 3",
"Email": "sample string 4",
"Email2": "sample string 5",
"Name": "sample string 6",
"First": "sample string 7",
"Last": "sample string 8",
"Phone": "sample string 9",
"School": "sample string 10",
"Class": "sample string 11",
"Grade": "sample string 12",
"PassCode": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Link": "sample string 16",
"Filename": "sample string 17",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"ContactNotifications": [
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Notification": {
"Id": 1,
"FolderId": 2,
"Type": 0,
"From": "sample string 3",
"To": "sample string 4",
"Subject": "sample string 5",
"Message": "sample string 6",
"Status": "sample string 7",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"SendDateTime": "2025-07-18T12:48:27.203927+00:00",
"ProcessDateTime": "2025-07-18T12:48:27.203927+00:00",
"WithPhotos": true,
"WithoutPhotos": true,
"NoClicks": true,
"ContactNotifications": []
}
},
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Notification": {
"Id": 1,
"FolderId": 2,
"Type": 0,
"From": "sample string 3",
"To": "sample string 4",
"Subject": "sample string 5",
"Message": "sample string 6",
"Status": "sample string 7",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"SendDateTime": "2025-07-18T12:48:27.203927+00:00",
"ProcessDateTime": "2025-07-18T12:48:27.203927+00:00",
"WithPhotos": true,
"WithoutPhotos": true,
"NoClicks": true,
"ContactNotifications": []
}
}
]
}
],
"Notifications": [
{
"Id": 1,
"FolderId": 2,
"Type": 0,
"From": "sample string 3",
"To": "sample string 4",
"Subject": "sample string 5",
"Message": "sample string 6",
"Status": "sample string 7",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"SendDateTime": "2025-07-18T12:48:27.203927+00:00",
"ProcessDateTime": "2025-07-18T12:48:27.203927+00:00",
"WithPhotos": true,
"WithoutPhotos": true,
"NoClicks": true,
"ContactNotifications": [
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Contact": {
"Id": 1,
"DocumentId": 2,
"FolderId": 1,
"Tag": "sample string 3",
"Email": "sample string 4",
"Email2": "sample string 5",
"Name": "sample string 6",
"First": "sample string 7",
"Last": "sample string 8",
"Phone": "sample string 9",
"School": "sample string 10",
"Class": "sample string 11",
"Grade": "sample string 12",
"PassCode": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Link": "sample string 16",
"Filename": "sample string 17",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"ContactNotifications": []
}
},
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Contact": {
"Id": 1,
"DocumentId": 2,
"FolderId": 1,
"Tag": "sample string 3",
"Email": "sample string 4",
"Email2": "sample string 5",
"Name": "sample string 6",
"First": "sample string 7",
"Last": "sample string 8",
"Phone": "sample string 9",
"School": "sample string 10",
"Class": "sample string 11",
"Grade": "sample string 12",
"PassCode": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Link": "sample string 16",
"Filename": "sample string 17",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"ContactNotifications": []
}
}
]
},
{
"Id": 1,
"FolderId": 2,
"Type": 0,
"From": "sample string 3",
"To": "sample string 4",
"Subject": "sample string 5",
"Message": "sample string 6",
"Status": "sample string 7",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"SendDateTime": "2025-07-18T12:48:27.203927+00:00",
"ProcessDateTime": "2025-07-18T12:48:27.203927+00:00",
"WithPhotos": true,
"WithoutPhotos": true,
"NoClicks": true,
"ContactNotifications": [
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Contact": {
"Id": 1,
"DocumentId": 2,
"FolderId": 1,
"Tag": "sample string 3",
"Email": "sample string 4",
"Email2": "sample string 5",
"Name": "sample string 6",
"First": "sample string 7",
"Last": "sample string 8",
"Phone": "sample string 9",
"School": "sample string 10",
"Class": "sample string 11",
"Grade": "sample string 12",
"PassCode": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Link": "sample string 16",
"Filename": "sample string 17",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"ContactNotifications": []
}
},
{
"Id": 1,
"NotificationId": 2,
"ContactId": 3,
"Status": 4,
"MessageId": "sample string 5",
"Contact": {
"Id": 1,
"DocumentId": 2,
"FolderId": 1,
"Tag": "sample string 3",
"Email": "sample string 4",
"Email2": "sample string 5",
"Name": "sample string 6",
"First": "sample string 7",
"Last": "sample string 8",
"Phone": "sample string 9",
"School": "sample string 10",
"Class": "sample string 11",
"Grade": "sample string 12",
"PassCode": "sample string 13",
"Custom1": "sample string 14",
"Custom2": "sample string 15",
"Link": "sample string 16",
"Filename": "sample string 17",
"CreateDateTime": "2025-07-18T12:48:27.203927+00:00",
"ContactNotifications": []
}
}
]
}
],
"Documents": [
{
"Id": 1,
"GalleryId": 1,
"UserId": "sample string 2",
"Bucket": "sample string 3",
"Folder": "sample string 4",
"FileName": "sample string 5",
"Status": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"FolderId": 1,
"DocumentType": 0
},
{
"Id": 1,
"GalleryId": 1,
"UserId": "sample string 2",
"Bucket": "sample string 3",
"Folder": "sample string 4",
"FileName": "sample string 5",
"Status": "sample string 6",
"CreateDate": "2025-07-18T12:48:27.203927+00:00",
"FolderId": 1,
"DocumentType": 0
}
],
"SubFolders": []
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.