staqlydocs
REST APIAPI referenceCollections

Get a collection

Get a collection

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/collections/{id}

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Response Body

OK

application/json
  1. response
id*string
name*string
description*string
icon*string
color*string
processing_timeout_seconds*|

How long a target on your own automation may wait for a result before it fails, in seconds (60 to 86400); null = the server's PROCESSING_TIMEOUT (see defaults.processing_timeout_seconds on GET /session).

is_default*boolean

The workspace's Default collection. Every workspace has exactly one; it can be renamed but not archived or deleted (409).

archived*boolean
archived_at*string|null
created_at*string
updated_at*string
post_count*integer
status_counts*

Posts by status

curl -X GET 'https://staqly.example.com/v1/collections/string'
{  "id": "string",  "name": "string",  "description": "string",  "icon": "string",  "color": "string",  "processing_timeout_seconds": 0,  "is_default": true,  "archived": true,  "archived_at": "string",  "created_at": "string",  "updated_at": "string",  "post_count": 0,  "status_counts": {    "property1": 0,    "property2": 0  }}