Get Users With Folder Access

GET 
/projects/folders/:folderId/users

Lists users with access to the folder as one unified users page (source: direct | inherited). skip / limit / total apply to the combined list. No PII and no query filter. Revoke with DELETE /projects/folders/{folderId}/users/{userId}.

Request

Version stringrequired

API Version

Available optionsv3

folderId stringrequired

Folder id

skip number

Number of users to skip in the unified users page (direct grants first, then inherited). Defaults to 0.

Possible values: >= 0

Default value:0

limit number

Page size for the unified users list. Defaults to 50; capped server-side at 50.

Possible values: >= 1 and <= 50

Default value:50

locationId string

Location id. Required for channel: APP. Ignored for OAuth/PIT — those use the location on the auth token. Do not send in path, body, or headers.

application/json

Successful response

application/json

Schema

Schema

usersobject[]required

One page of grants (direct first, then inherited)

skipnumberrequired

Echoed page offset into the unified users list

limitnumberrequired

Echoed page size (max 50)

totalnumberrequired

Total users after merge (direct + inherited), before pagination

Example (auto)

{
  "users": [
    {
      "userId": "user_1",
      "principalType": "user",
      "mode": "allow",
      "source": "direct",
      "inheritedFrom": null
    },
    {
      "userId": "user_2",
      "principalType": "user",
      "mode": "allow",
      "source": "inherited",
      "inheritedFrom": {
        "id": "6a102435124ecfb348bd5506",
        "name": "Marketing",
        "type": "space"
      }
    }
  ],
  "skip": 0,
  "limit": 50,
  "total": 2
}