Inconsistent response in Endpoint Get Folder API

1 reply
46 views
Translate All

When using the EndPoint Get Folder https://api.lucid.co/folders/{id}

If the folder is in a Team Folder, the json response returns:

"id": 123456789,
"type": "folder",
"name": "Folder Name",
"created": "2020-06-26T16:29:37Z",
"trashed": "2022-01-20T12:14:18Z",
"attributes": [
{
"name": "Sample Label",
"value": "Sample Value"
}
]

without Parent field which could crash your logic to decode the result.

If the folder is elsewhere (MyDocument, ...) the parent is returned.

"id": 123456789,
"type": "folder",
"name": "Folder Name",
"parent": 123456788,
"created": "2020-06-26T16:29:37Z",
"trashed": "2022-01-20T12:14:18Z",
"attributes": [
{
"name": "Sample Label",
"value": "Sample Value"
}
]

Very strange IMHO.

Regards.

Pinned Reply By Caden E

Hi Michel,

Great question. I’ll direct you to the docs page for this endpoint, which has some important info.

Note the description under type in the Response Body section:

Folders with type folder that are inside other folders (including team folders) will have a parent field, which will have their parent folder’s ID
Folders with type folder that are inside “My Documents” will have their parent field set to null
Team folders (type team) will have no parent field at all

Admittedly, this behavior could be smoother. It may be the case in the future that we create a version 2 of this endpoint that handles these cases in a more intuitive way. But for now, it’s working as intended.

View in thread

C

Caden EPinned

Lucid product team

Hi Michel,

Great question. I’ll direct you to the docs page for this endpoint, which has some important info.

Note the description under type in the Response Body section:

Folders with type folder that are inside other folders (including team folders) will have a parent field, which will have their parent folder’s ID
Folders with type folder that are inside “My Documents” will have their parent field set to null
Team folders (type team) will have no parent field at all

Admittedly, this behavior could be smoother. It may be the case in the future that we create a version 2 of this endpoint that handles these cases in a more intuitive way. But for now, it’s working as intended.

Translate

Create an account in the community

Log in to the community