Skip to main content

Folders

Folders organize your links. A link can be placed in a folder via the linkConfigurations.folder_id field when creating or updating it.

All endpoints require an API key with the scope noted on each.

List folders​

GET /folders

Scope: folders.read

curl https://api.prolinksqr.com/folders \
  -H "Authorization: Basic key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response 200​

{
  "data": [
    { "id": "0c8f...e21", "name": "Campaigns" },
    { "id": "9a13...77b", "name": "Events" }
  ]
}

Get a folder​

GET /folders/:id

Scope: folders.read

curl https://api.prolinksqr.com/folders/0c8f...e21 \
  -H "Authorization: Basic key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Create a folder​

POST /folders

Scope: folders.create

FieldTypeRequired
namestringyes
curl -X POST https://api.prolinksqr.com/folders \
  -H "Authorization: Basic key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Campaigns" }'

Response 200​

{ "data": { "id": "0c8f...e21", "name": "Campaigns" } }

Update a folder​

PUT /folders/:id

Scope: folders.update

FieldTypeRequired
namestringyes
curl -X PUT https://api.prolinksqr.com/folders/0c8f...e21 \
  -H "Authorization: Basic key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Spring Campaigns" }'

Delete a folder​

DELETE /folders/:id

Scope: folders.delete

curl -X DELETE https://api.prolinksqr.com/folders/0c8f...e21 \
  -H "Authorization: Basic key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"