List connections
Every store connected to the workspace, and those waiting for confirmation.
GET
Every store connected to the workspace, and those waiting for confirmation.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200type?stringComma-separated, any of: shopify
state?stringComma-separated, any of: connected, importing, pending, needs_attention, disconnected
sort?stringOne of name, connectedAt; prefix with - for descending
Default
"name"Value in
"name""-name""connectedAt""-connectedAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/connections'{ "items": [ { "key": "string", "type": "shopify", "name": "string", "identifier": "string", "state": "connected", "connectedAt": "2019-08-24T14:15:22Z", "path": "string", "connectIntentId": "ae2d5bce-a58a-4237-be81-3cc8c2064de4" } ], "total": 0, "page": 0, "pageSize": 0}