Read an integration tool descriptor
Returns one tool's full descriptor. A revision that no longer matches the integration's tools returns 409.
GET
Returns one tool's full descriptor. A revision that no longer matches the integration's tools returns 409.
apiKeyheader
x-api-key<token>integrationId*stringMatch
^intg_[0-9a-hjkmnp-tv-z]{16,24}$tool*stringMatch
^[a-z][a-z0-9_.]{0,63}$offset?|nullrevision?stringMatch
^[a-f0-9]{64}$Success
application/json- response
data*stringLength
length <= 32000offset*integerRange
0 <= value <= 9007199254740991nextOffset*|nulltotalCharacters*integerRange
0 <= value <= 9007199254740991revision*stringMatch
^[a-f0-9]{64}$import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.integrations.readTool({
"integrationId": "example",
"tool": "example"
});Example Response
{
"data": "string",
"offset": 0,
"nextOffset": 0,
"totalCharacters": 0,
"revision": "string"
}