listFolders
Every folder on one surface.
Every folder on one surface (scope: PROPERTY, CONTACT, DEAL, FORM, …), flat: the org's shared tree plus your personal one. ownerUserId set = personal. itemCount counts items filed directly in it. Filter folders also come from listFilterFolders; workflow and template folders have their own ops.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "listFolders",
"variables": {
"scope": "PROPERTY"
}
}'import { GoliathClient } from '@goliath-data/sdk'
const goliath = new GoliathClient({
apiKey: process.env.GOLIATH_API_KEY!,
baseUrl: 'https://server.goliathdata.com',
})
// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
scope: 'PROPERTY'
} as Parameters<typeof goliath.properties.listFolders>[0]
const result = await goliath.properties.listFolders(variables)const res = await fetch('https://server.goliathdata.com/api/v1/call', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
operationId: 'listFolders',
variables: {
scope: 'PROPERTY'
}
}),
})
const { data, errors } = await res.json()Variables
The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.
The surface a folder appears on. The first nine are 1:1 with `FilterType`: a folder there holds that surface's saved filters, and on PROPERTY / CONTACT its lists as well. Scope is the SURFACE, not the item kind.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"folderQuery": {
"folders": [
{
"id": "<ID>",
"name": "…",
"scope": "PROPERTY",
"parentId": "<ID>",
"ownerUserId": "<ID>",
"displayOrder": 0,
"itemCount": 0
}
]
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.
Behaviour
A read. It rejects an Idempotency-Key header with 400 bad_request.