List the tenant's share links
const url = 'https://api.pixonaut.app/v1/share-links?page=1&pageSize=50&kind=designer&createdBy=me&carriesVisit=true&neverExpires=true&sort=created';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.pixonaut.app/v1/share-links?page=1&pageSize=50&kind=designer&createdBy=me&carriesVisit=true&neverExpires=true&sort=created' \ --header 'Authorization: Bearer <token>'Operation ID: shareLinks.list
Links that still work, of the kinds the caller may hand out (to a connected store’s integration key, every link its store handed out, designer links included), newest first or by expiry, 100 a page at most, narrowed by kind, subject, who handed them out, whether they carry a visit, when they stop working, and text. Never the token itself. counts says what each kind, each source and the visit filter would answer, each under every other filter, in the same read.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The page to read, from 1; the first when left out.
The page to read, from 1; the first when left out.
Only the link holding this name, case aside: with pageSize=1, whether a name is free.
Only the link holding this name, case aside: with pageSize=1, whether a name is free.
Only the links about this template, design or order.
Only the links about this template, design or order.
Only links of this kind.
Only links of this kind.
Only links handed out by members, by a key (any secret key or connected store), by the key or store of this id, or auto: sent with an order to a custom printshop.
Only links handed out by members, by a key (any secret key or connected store), by the key or store of this id, or auto: sent with an order to a custom printshop.
Only the links the caller handed out.
Only the links the caller handed out.
true, only links carrying one shopper’s visit (state); false, only those that do not.
true, only links carrying one shopper’s visit (state); false, only those that do not.
Only links that stop working within this many days.
Only links that stop working within this many days.
true, only links that never expire; false, only those that do.
true, only links that never expire; false, only those that do.
Only links whose name, subject’s name, link id, or member or key that handed it out holds this text, case aside.
Only links whose name, subject’s name, link id, or member or key that handed it out holds this text, case aside.
created (the default), newest first; expires, the soonest to stop working first, those that never do last.
created (the default), newest first; expires, the soonest to stop working first, those that never do last.
Responses
Section titled “Responses”A page of links
object
What each filter’s choices would answer, in this one read.
object
How many links in view carry one shopper’s visit, under every filter but carriesVisit.
Each kind the caller may manage, under every other filter.
object
Members and printshop orders, then each key or store with links in view, under every filter but source.
object
object
object
Null for a key the deployment configures.
object
sk for a secret key, ik for a connected store; null once the key is gone.
The key’s label, or the store’s; null once the key is gone.
object
The brand the link’s page is drawn in; null for the workspace’s default, whichever that is when it opens.
The member who handed it out; null when no member did.
object
The secret key or connected store that handed the link out.
object
sk for a secret key, ik for a connected store; null once the key is gone.
The key’s label, or the store’s; null once the key is gone.
How many designs a designer link may make; null for none.
object
How many designs the link may make in its period.
total counts every design the link made; hour, day and week the last 60 minutes, 24 hours or 7 days, rolling.
At the limit, when the link makes designs again; null below it, and for a total limit.
The designs the limit counts now: one per side approved, in the rolling window.
How many designs a designer link made, one per side approved; null for any other kind.
When the link stops working; null for one that never does.
When its page last opened, to the hour; null for never.
The language the link’s page is shown in, which its url names as ?lang=<locale>; null when it names none, and the page is shown in the workspace’s default language.
The workspace’s name for the link.
Whether a designer link’s page draws the placement frame around the shopper’s picture at rest; false for every other link.
Whether a designer link’s page draws the print area’s frame; false for every other link.
Who handed it out: member; key, a secret key or connected store (createdByKey, null for a key the deployment configures); auto, sent with an order to a custom printshop.
What the link is about; null once it no longer exists.
object
The subject’s name: a template’s name; for a design, the name of its template; for an order, its external reference, null when it has none.
object
The blank its sides are printed on; null for none.
object
Whether the link carries one shopper’s visit (state).
The host its page sends a shopper back to; null for none.
One entry per side, one for a link with one.
object
The sizes its menu offers; empty for none.
object
object
object
The printshop the order went to; null for none.
object
What keeps the page from opening for now: template_paused (it opens again once the template is live), printshop_disconnected; null for nothing.
A designer link’s address, which it keeps: it sits on a store’s page until withdrawn. It carries ?lang=<locale> when the link names a locale. Null for every other kind, whose address is shown once, and for a designer link made before addresses were kept until it is regenerated.
Examples
Example
{ "counts": { "carriesVisit": 12, "kinds": [ { "count": 12, "kind": "designer" }, { "count": 1, "kind": "proof-page" } ], "sources": [ { "count": 1, "source": "member" }, { "count": 0, "source": "auto" }, { "count": 12, "key": { "id": "key_5e4f3a2b1c0d", "kind": "ik", "name": "WooCommerce · Corner shop (shop.example)" }, "source": "key" } ] }, "links": [ { "brandId": null, "createdAt": 1760000000000, "createdBy": { "name": "Alexandra Lind", "userId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d" }, "createdByKey": null, "designLimit": null, "designs": null, "expiresAt": 1761209600000, "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "kind": "proof-page", "lastOpenedAt": 1760400000000, "locale": null, "mayDecide": true, "name": "Proof for Anna", "placementFrame": false, "printAreaFrame": false, "returnUrl": null, "source": "member", "subject": { "label": "Print of T-shirt print, front", "meta": { "status": "committed", "type": "design" }, "warning": null }, "subjectId": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f", "url": null } ], "page": 1, "pageSize": 50, "total": 1}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: origin_forbidden, feature_disabled
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}origin_forbidden
{ "error": "origin_forbidden"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: invalid_query
object
Examples
invalid_query
{ "error": "invalid_query"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].