Skip to content

by Startups.Studio

Ad.list

GET /{namespace}/ads

Returns Ads, newest first, one page at a time.

Noun: Ad
Mode: read

You, to your agent

Show me my ad records, newest first.

curl "https://api.sb/shiftnote.app/ads?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const ads = await $.Ad.list({ limit: 20 })

npx startup-builder do Ad.list --json '{"limit":20}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Ad.list({ limit: 20 })"
  }
}

List returns Ads, newest first, one page at a time. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`limit`	`integer`		At most this many records, up to 100. The default is 20.
`after`	`string`		The cursor from the previous page.
`where`	`string`		A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`		Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`		True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`		Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`		Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`		Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`		How many levels of related records to embed. The default is 1.
`q`	`string`		Words to match across the text properties, ranked by relevance.
`match`	`string`		Ranks the search by `words`, or `meaning`; words is the default.

Outputs

Output	Type	Required	Description
`ads`	list of Ad	required	One page of Ads.

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.	Ad.list

When it waits

Never: a read runs at once.

Ad.get

Previous Page

Ad.update

Next Page