Cards

List cards

Returns a paginated list of lightweight card summaries from your personal workspace or a business workspace you own or administer. Other workspaces, including business workspaces where you are only a member, return 404.

Deleted cards, drafts, and card templates are excluded. Each summary includes the public sharing URL for the card.

Cards are sorted by creation time, newest first, with the card ID as a tie-breaker, so pages are deterministic. Cursors are bound to the requesting key owner and workspace.

Requires the blinq:cards:read scope.

get/v1/workspaces/{workspace_id}/cards

Request

  • Base URL
    https://api.blinq.me
  • Auth
    HTTP bearer

Path parameters

workspace_idstring required

The workspace ID. Use an id returned by the list workspaces endpoint.

Query parameters

cursorstring

The next_cursor returned by the previous response. Omit for the first page. Keep the workspace unchanged between pages.

limitinteger

The maximum number of cards to return per page.

Response

One page of card summaries.

has_moreboolean required

Whether another page of cards is available.

next_cursorstring nullable required

The cursor for the next page. When has_more is true, pass this value as cursor. Otherwise, this value is null.

total_countinteger nullable required

The total number of visible cards in the workspace. Returned on the first page; null on subsequent pages.

Example response

{
  "cards": [
    {
      "id": "card-id",
      "workspace_id": "workspace-id",
      "url": "https://blinq.me/card-id",
      "card_title": "Work",
      "first_name": "Jane",
      "last_name": "Doe",
      "job_title": "Designer",
      "company_name": "Example",
      "department": null,
      "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
    }
  ]
}

Changes

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