Documentation
Read a Library item
GET
/v1/presets/{preset}LibraryParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
preset | string, in the path | required |
Example request
curl -s "https://snip.link/v1/presets/preset" \ -H "Authorization: Bearer $SNIP_KEY"
Example response
{
"preset": {
"kind": "rules"
}
}Response fields
| Field | Type | Description |
|---|---|---|
preset | LibraryItem | |
preset.id | string | |
preset.kind | rules | qr | campaign | preview | template | |
preset.name | string | |
preset.description | string | |
preset.config | object | |
preset.version | integer | |
preset.is_default | boolean | |
preset.created_at | string | |
preset.updated_at | string |
Errors
| Status | Meaning |
|---|---|
| 400 | The body or query is invalid. details names each field. |
| 401 | The API key is missing, malformed or revoked. |
| 403 | This account role cannot perform the action. details.reason identifies the permission refusal. |
| 404 | No Library item or selected link in the authenticated account. |
| 409 | The item or a selected link changed. Read it again and preview before retrying. |
| 413 | The input is larger than the plan allows per run. details carries the size, the limit and the unit. |
| 429 | Either the key exceeded its requests-per-second limit (honor Retry-After), or a daily or plan quota is used up (details.reason). |
| 503 | The feature is switched off for the service right now. Try again later. |