Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Directory (Sites)

Retrieve a folder

get/directory/v1/folder/{id}

Path parameters

idstring required

Required. The folder identifier to retrieve info for

Query parameters

with_ancestorsboolean

When true, an array of the folders ancestors will also be returned.

with_all_children_countboolean

When true, the total count of all children underneath the folder will be returned. This is a recursive count and will include children of children

Response

A successful response.

all_children_countinteger

The total count of children underneath the folder. I Including children of children recursively

member_countinteger

The number of users with a direct association of type 'MEMBER' for the folder

deletedboolean

Whether the folder is deleted or not

Example response

{
  "folder": {
    "id": "4fb56fa8-fa23-4a9c-907e-8367abc75a2f",
    "name": "Sydney",
    "org_id": "d31e24be-e7a4-4a28-a230-044f850041fc",
    "creator_id": "a3452937-9fa7-4ba2-9ffa-c3bbee3fc947",
    "created_at": "2020-04-28T04:14:31:00Z",
    "modified_at": "2020-04-28T04:14:31:00Z",
    "meta_label": "location"
  },
  "ancestors": [
    {
      "id": "4fb56fa8-fa23-4a9c-907e-8367abc75a2f",
      "name": "Sydney",
      "org_id": "d31e24be-e7a4-4a28-a230-044f850041fc",
      "creator_id": "a3452937-9fa7-4ba2-9ffa-c3bbee3fc947",
      "created_at": "2020-04-28T04:14:31:00Z",
      "modified_at": "2020-04-28T04:14:31:00Z",
      "meta_label": "location"
    }
  ]
}