Get SharePoint items by full path

GET

/api/sharepoint/item

SharePoint APIs

Fetches SharePoint items using a fullpath query parameter. If no parameter is provided, all non-deleted items are returned.

Response Example

200 - Example 1

{
    "document_index_id": 1,
    "item_sp_id": 1234,
    "item_name": "Test Document",
    "fullpath": "/documents/test_document",
    "is_folder": false,
    "is_deleted": false
}

Request

Query Params

fullpath

string

optional

The full path of the SharePoint item to search for.

Responses

🟢200OK

application/json

Successfully retrieved SharePoint item(s).

Body

array of:

document_index_id

integer

optional

The ID of the document this item is indexed under.

item_sp_id

integer

optional

Unique SharePoint item ID.

item_name

string

optional

The name of the SharePoint item.

fullpath

string

optional

Full path of the SharePoint item.

is_folder

boolean

optional

Indicates if the item is a folder.

is_deleted

boolean

optional

Indicates if the item is marked as deleted.

🟠404Record Not Found

🔴500Server Error

Get Dataset Queries

Get a SharePoint item by its ID