Skip to content

by Startups.Studio

Core grammar Thing Collection

Collection.get

GET /{namespace}/collections/{id}

Returns one Collection by id.

Noun: Collection
Mode: read

You, to your agent

Show me the latest collection.

curl https://api.sb/quietcopy.com/collections/collection_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const collection = await $.Collection.get({ id: 'collection_1' })

npx startup-builder do Collection.get --json '{"id":"collection_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Collection.get({ id: 'collection_1' })"
  }
}

Get returns one Collection by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Collection.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

Output	Type	Required	Description
`collection`	Collection	required	The Collection.

Effects

Reads only: it emits no Event and changes nothing.
Read: try, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Collection.get

When it waits

Never: a read runs at once.

Collection.export

Previous Page

Collection.list

Next Page