cURL
curl "https://api.alura.io/v1/workspace/syncs" \
-H "Authorization: Bearer $ALURA_API_KEY"const res = await fetch('https://api.alura.io/v1/workspace/syncs', {
headers: {
Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
},
});
console.log(await res.json());import json
import os
import urllib.request
request = urllib.request.Request(
"https://api.alura.io/v1/workspace/syncs",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "list",
"data": [
{
"object": "workspace.sync",
"id": "syn_9004",
"shop_id": "22841907",
"status": "queued",
"trigger": "api",
"progress": 0,
"steps": [
{
"name": "settings",
"status": "pending"
},
{
"name": "listings",
"status": "pending"
},
{
"name": "orders",
"status": "pending"
},
{
"name": "reviews",
"status": "pending"
},
{
"name": "finances",
"status": "pending"
},
{
"name": "customers",
"status": "pending"
}
],
"requested_at": "2026-10-17T12:00:00.000Z",
"started_at": null,
"completed_at": null,
"estimated_ready_at": null,
"error": null
},
{
"object": "workspace.sync",
"id": "syn_9003",
"shop_id": "30577120",
"status": "running",
"trigger": "app",
"progress": 0.33,
"steps": [
{
"name": "settings",
"status": "succeeded"
},
{
"name": "listings",
"status": "succeeded"
},
{
"name": "orders",
"status": "running"
},
{
"name": "reviews",
"status": "running"
},
{
"name": "finances",
"status": "pending"
},
{
"name": "customers",
"status": "pending"
}
],
"requested_at": "2026-10-17T11:58:00.000Z",
"started_at": "2026-10-17T11:58:05.000Z",
"completed_at": null,
"estimated_ready_at": null,
"error": null
},
{
"object": "workspace.sync",
"id": "syn_9002",
"shop_id": "48911633",
"status": "failed",
"trigger": "scheduled",
"progress": 1,
"steps": [
{
"name": "settings",
"status": "failed"
},
{
"name": "listings",
"status": "not_run"
},
{
"name": "orders",
"status": "not_run"
},
{
"name": "reviews",
"status": "not_run"
},
{
"name": "finances",
"status": "not_run"
},
{
"name": "customers",
"status": "not_run"
}
],
"requested_at": "2026-10-16T06:00:00.000Z",
"started_at": "2026-10-16T06:00:04.000Z",
"completed_at": "2026-10-16T06:00:06.000Z",
"estimated_ready_at": null,
"error": {
"code": "reconnect_required",
"message": "The shop's Etsy connection has ended; reconnect it in Alura, then sync again."
}
},
{
"object": "workspace.sync",
"id": "syn_9001",
"shop_id": "22841907",
"status": "succeeded",
"trigger": "scheduled",
"progress": 1,
"steps": [
{
"name": "settings",
"status": "succeeded"
},
{
"name": "listings",
"status": "succeeded"
},
{
"name": "orders",
"status": "succeeded"
},
{
"name": "reviews",
"status": "succeeded"
},
{
"name": "finances",
"status": "succeeded"
},
{
"name": "customers",
"status": "succeeded"
}
],
"requested_at": "2026-10-16T06:00:00.000Z",
"started_at": "2026-10-16T06:00:03.000Z",
"completed_at": "2026-10-16T06:04:41.000Z",
"estimated_ready_at": null,
"error": null
}
],
"has_more": false,
"next_cursor": null,
"total": {
"value": 4,
"relation": "eq"
}
}{
"type": "https://docs.alura.io/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Invalid request",
"suggestion": "Fix the request as the detail says, then send it again.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_exhausted",
"title": "API credits exhausted",
"status": 402,
"code": "credits_exhausted",
"detail": "API credits exhausted",
"suggestion": "Upgrade the plan or wait for the monthly reset.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/plan_required",
"title": "Plan required",
"status": 403,
"code": "plan_required",
"detail": "Plan required",
"suggestion": "Upgrade the workspace plan to use this operation.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Not found",
"suggestion": "Check the ID, or search for it first.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/rate_limited",
"title": "Rate limited",
"status": 429,
"code": "rate_limited",
"detail": "Rate limited",
"suggestion": "Wait for Retry-After, then retry.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/internal_error",
"title": "Internal error",
"status": 500,
"code": "internal_error",
"detail": "Internal error",
"suggestion": "Retry; if it keeps failing, report the request_id.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_unavailable",
"title": "API credits unavailable",
"status": 503,
"code": "credits_unavailable",
"detail": "API credits unavailable",
"suggestion": "Retry shortly.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}Syncs
List syncs
The syncs of your connected Etsy shops: first each shop’s latest sync, newest first, then the earlier ones, newest first. Filter by shop_id. Syncs are kept for 90 days. total is exact up to 1,000 syncs, then {"value": 1000, "relation": "gte"}. Costs 1 API credit per page with results; an empty page is free.
Cost: 1 API credit per page.
cURL
curl "https://api.alura.io/v1/workspace/syncs" \
-H "Authorization: Bearer $ALURA_API_KEY"const res = await fetch('https://api.alura.io/v1/workspace/syncs', {
headers: {
Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
},
});
console.log(await res.json());import json
import os
import urllib.request
request = urllib.request.Request(
"https://api.alura.io/v1/workspace/syncs",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "list",
"data": [
{
"object": "workspace.sync",
"id": "syn_9004",
"shop_id": "22841907",
"status": "queued",
"trigger": "api",
"progress": 0,
"steps": [
{
"name": "settings",
"status": "pending"
},
{
"name": "listings",
"status": "pending"
},
{
"name": "orders",
"status": "pending"
},
{
"name": "reviews",
"status": "pending"
},
{
"name": "finances",
"status": "pending"
},
{
"name": "customers",
"status": "pending"
}
],
"requested_at": "2026-10-17T12:00:00.000Z",
"started_at": null,
"completed_at": null,
"estimated_ready_at": null,
"error": null
},
{
"object": "workspace.sync",
"id": "syn_9003",
"shop_id": "30577120",
"status": "running",
"trigger": "app",
"progress": 0.33,
"steps": [
{
"name": "settings",
"status": "succeeded"
},
{
"name": "listings",
"status": "succeeded"
},
{
"name": "orders",
"status": "running"
},
{
"name": "reviews",
"status": "running"
},
{
"name": "finances",
"status": "pending"
},
{
"name": "customers",
"status": "pending"
}
],
"requested_at": "2026-10-17T11:58:00.000Z",
"started_at": "2026-10-17T11:58:05.000Z",
"completed_at": null,
"estimated_ready_at": null,
"error": null
},
{
"object": "workspace.sync",
"id": "syn_9002",
"shop_id": "48911633",
"status": "failed",
"trigger": "scheduled",
"progress": 1,
"steps": [
{
"name": "settings",
"status": "failed"
},
{
"name": "listings",
"status": "not_run"
},
{
"name": "orders",
"status": "not_run"
},
{
"name": "reviews",
"status": "not_run"
},
{
"name": "finances",
"status": "not_run"
},
{
"name": "customers",
"status": "not_run"
}
],
"requested_at": "2026-10-16T06:00:00.000Z",
"started_at": "2026-10-16T06:00:04.000Z",
"completed_at": "2026-10-16T06:00:06.000Z",
"estimated_ready_at": null,
"error": {
"code": "reconnect_required",
"message": "The shop's Etsy connection has ended; reconnect it in Alura, then sync again."
}
},
{
"object": "workspace.sync",
"id": "syn_9001",
"shop_id": "22841907",
"status": "succeeded",
"trigger": "scheduled",
"progress": 1,
"steps": [
{
"name": "settings",
"status": "succeeded"
},
{
"name": "listings",
"status": "succeeded"
},
{
"name": "orders",
"status": "succeeded"
},
{
"name": "reviews",
"status": "succeeded"
},
{
"name": "finances",
"status": "succeeded"
},
{
"name": "customers",
"status": "succeeded"
}
],
"requested_at": "2026-10-16T06:00:00.000Z",
"started_at": "2026-10-16T06:00:03.000Z",
"completed_at": "2026-10-16T06:04:41.000Z",
"estimated_ready_at": null,
"error": null
}
],
"has_more": false,
"next_cursor": null,
"total": {
"value": 4,
"relation": "eq"
}
}{
"type": "https://docs.alura.io/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Invalid request",
"suggestion": "Fix the request as the detail says, then send it again.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_exhausted",
"title": "API credits exhausted",
"status": 402,
"code": "credits_exhausted",
"detail": "API credits exhausted",
"suggestion": "Upgrade the plan or wait for the monthly reset.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/plan_required",
"title": "Plan required",
"status": 403,
"code": "plan_required",
"detail": "Plan required",
"suggestion": "Upgrade the workspace plan to use this operation.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Not found",
"suggestion": "Check the ID, or search for it first.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/rate_limited",
"title": "Rate limited",
"status": 429,
"code": "rate_limited",
"detail": "Rate limited",
"suggestion": "Wait for Retry-After, then retry.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/internal_error",
"title": "Internal error",
"status": 500,
"code": "internal_error",
"detail": "Internal error",
"suggestion": "Retry; if it keeps failing, report the request_id.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "https://docs.alura.io/errors/credits_unavailable",
"title": "API credits unavailable",
"status": 503,
"code": "credits_unavailable",
"detail": "API credits unavailable",
"suggestion": "Retry shortly.",
"retryable": true,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}Authorizations
An API key: Authorization: Bearer alura_sk_....
Query Parameters
Only these connected shops, comma-separated; default every connected shop of the workspace. A shop outside the workspace is 404.
Page size: default 25, at most 100.
Required range:
1 <= x <= 100The next_cursor of the previous page. Bound to the query, the workspace and the key.
Comma-separated dotted paths to return; id, object and as_of always come back.