Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/users/{userId}/resources

List User Resources

This API retrieves a list of all resources (folders and locations) associated with a user.

It includes:

  • Folders the user has access to.
  • Locations assigned to the user.
  • Access levels for each resource.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Path

NameTypeRequiredDescription
userIdstringrequiredBase64 encoded user ID

Request

Request
curl -X GET 'https://api.synup.com/api/v4/users/:userId/resources' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successfully retrieved user resources
Example response (generated from the schema)
{
  "data": {
    "listUserResources": [
      {
        "id": "string",
        "name": "string",
        "__typename": "Folder"
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.listUserResourcesarray of objectoptional
data.listUserResources[].idstringrequiredResource identifier (UUID format for folders, Base64 encoded for locations)
data.listUserResources[].namestringrequiredName of the resource
data.listUserResources[].__typenamestringrequiredType discriminator for the resource
FolderLocationSummary