Collections

Open a collection by its link

The viewer's read. ?t= (an invite token) is redeemed by the auth middleware.

get/collections/url/{url}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/collections/url/{url}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

urlstring required

Response

Collection

idinteger required
namestring required
descriptionstring nullable
urlstring required
project_idinteger required
workspace_idinteger required
rolestring required

'manager' (edits its project) or 'member'

dashboard_countinteger required
member_countinteger nullable

Managers only — a member never sees the roster

cover_urlstring nullable

The first published board's url token, for a thumbnail

shared_by_namestring nullable

Members only: who shared it with them

has_refreshboolean
updated_atstring date-time nullable
automation_idinteger nullable
refresh_folder_resource_idinteger nullable
refresh_datasetsobject[]

Changes

No recorded changes to this operation across all 3 revisions of this API.