Motives

List available motives

get/motives

Request

  • Base URL: https://api.echtpost.de/v2
  • URL: https://api.echtpost.de/v2/motives
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://my.echtpost.de/oauth/authorize, token URL https://my.echtpost.de/oauth/token, scopes: mcp)
    • API key in header X-Api-Key
    • HTTP bearer

Query parameters

pageinteger
per_pageinteger
searchstring

Search across name, description, content, and searchterms.

temporary'true' | 'false'

Filter by temporary API motives (true) or permanent motives (false).

sort'name' | 'created_at'
direction'asc' | 'desc'

Response

OK

idinteger
namestring
descstring nullable
orientation'vertical' | 'landscape'
highlightboolean
content_availableboolean
content_ps_availableboolean
vertical_text_availableboolean
qr_code_availableboolean
has_back_sideboolean

Whether this motive has a custom back-side image attached.

urlstring nullable

Link to the motive page on echtpost.de

preview_image_urlstring uri nullable

URL to a preview image of the motive front (~300-420px). For your own motives this is a signed asset URL that stays valid until the assets are purged (see assets_purged_at), and anyone holding the link can open the image.

back_side_image_urlstring uri nullable

URL to a preview image of the custom back side (~300-420px), or null when the motive has no custom back side. Signed asset URL with the same lifetime as preview_image_url.

tagsstring[]
temporaryboolean
assets_expires_atstring date nullable

Earliest date on which temporary motive assets may be purged. Null for permanent motives or already-purged assets without a pending expiry.

assets_purged_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.