GETapi.synup.com/api/v4/folders/default

Default folder

Returns the default folder (ID and name) configured for the specified user within the account. Returns null if the user has no default folder set.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

Name	Type	Required	Description
`userId`	integer	required	ID of the user whose default folder should be fetched.

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Request

curl -X GET 'https://api.synup.com/api/v4/folders/default?userId=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/folders/default?userId=', {
  method: 'GET',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});
const data = await res.json();

import requests
res = requests.get(
    "https://api.synup.com/api/v4/folders/default?userId=",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/folders/default?userId=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successful response
`401`	Unauthorized - Invalid or missing API key

Example response (generated from the schema)

{
  "data": {
    "defaultFolder": {
      "id": "string",
      "name": "string"
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.defaultFolder`	object	optional
`data.defaultFolder.id`	string	optional	Default folder ID.
`data.defaultFolder.name`	string	optional	Default folder name.