Folders

Retrieve folder

Retrieve a specific folder by its ID or path. You can use either the folder's ObjectID or its full path (e.g., 'INBOX/Subfolder') as the identifier.

get/v1/folders/{id}

Request

Base URL: https://api.forwardemail.net
URL: https://api.forwardemail.net/v1/folders/{id}
Auth: HTTP basic

Path parameters

idstring required

Folder ID or path

Response

Folder retrieved successfully

idstring required

Folder ID

pathstring required

Full folder path

namestring required

Folder name (last part of path)

parentstring nullable required

Parent folder path

uid_validityinteger required

IMAP UID validity

uid_nextinteger required

Next UID value

modify_indexinteger required

Modification index

subscribedboolean required

Whether folder is subscribed

flagsstring[] required

Folder flags

retentioninteger nullable required

Message retention period

special_usestring nullable required

Special use designation

created_atstring date-time required

updated_atstring date-time required

object'folder' required

Example response

{
  "id": "folder123",
  "path": "INBOX/Subfolder",
  "name": "Subfolder",
  "parent": "INBOX",
  "uid_validity": 123456,
  "uid_next": 1,
  "modify_index": 1,
  "subscribed": true,
  "flags": [],
  "retention": null,
  "special_use": null,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "object": "folder"
}

Changes

No recorded changes to this operation across all 1 revision of this API.