curl --request GET \
--url https://api.gigstack.io/v2/retentions/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/retentions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/retentions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"message": "Retention retrieved successfully",
"data": {
"id": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"uuid": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"status": "valid",
"document_type": "retenciones",
"retention_key": "26",
"folio_number": "1",
"series": "RET",
"issuer": {
"legal_name": "MI EMPRESA SA DE CV",
"tax_id": "MEE200101ABC",
"tax_system": "601"
},
"receiver": {
"legal_name": "GRUPO JINIM",
"tax_id": "EKU9003173C9",
"nationality": "Nacional"
},
"period": {
"start": 1,
"end": 1,
"year": 2026
},
"totals": {
"total_operation": 93116.98,
"total_taxable": 93116.98,
"total_exempt": 0,
"total_retained": 9777.27,
"tax_retained": [
{
"tax": "001",
"base": 93116.98,
"amount": 2327.92,
"payment_type": "03"
},
{
"tax": "002",
"base": 14898.71,
"amount": 7449.35,
"payment_type": "01"
}
]
},
"stamp": {
"uuid": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"stamped_at": "2026-01-15T10:30:45.000Z"
},
"verification_url": "https://verificacfdi.facturaelectronica.sat.gob.mx/default.aspx?id=9d9b0e5b-034c-42f7-bd21-3a868a57c13e&re=MEE200101ABC&rr=EKU9003173C9&tt=93116.98&fe=abcd1234",
"livemode": true,
"created_at": 1736942445000,
"metadata": null
},
"success": true,
"timestamp": 1767225600000
}Get retention
Retrieve a specific tax retention document by ID (UUID).
gigstack Connect: View other teams’ retentions using the team parameter.
curl --request GET \
--url https://api.gigstack.io/v2/retentions/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/retentions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/retentions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"message": "Retention retrieved successfully",
"data": {
"id": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"uuid": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"status": "valid",
"document_type": "retenciones",
"retention_key": "26",
"folio_number": "1",
"series": "RET",
"issuer": {
"legal_name": "MI EMPRESA SA DE CV",
"tax_id": "MEE200101ABC",
"tax_system": "601"
},
"receiver": {
"legal_name": "GRUPO JINIM",
"tax_id": "EKU9003173C9",
"nationality": "Nacional"
},
"period": {
"start": 1,
"end": 1,
"year": 2026
},
"totals": {
"total_operation": 93116.98,
"total_taxable": 93116.98,
"total_exempt": 0,
"total_retained": 9777.27,
"tax_retained": [
{
"tax": "001",
"base": 93116.98,
"amount": 2327.92,
"payment_type": "03"
},
{
"tax": "002",
"base": 14898.71,
"amount": 7449.35,
"payment_type": "01"
}
]
},
"stamp": {
"uuid": "9d9b0e5b-034c-42f7-bd21-3a868a57c13e",
"stamped_at": "2026-01-15T10:30:45.000Z"
},
"verification_url": "https://verificacfdi.facturaelectronica.sat.gob.mx/default.aspx?id=9d9b0e5b-034c-42f7-bd21-3a868a57c13e&re=MEE200101ABC&rr=EKU9003173C9&tt=93116.98&fe=abcd1234",
"livemode": true,
"created_at": 1736942445000,
"metadata": null
},
"success": true,
"timestamp": 1767225600000
}Authorizations
Authentication Method: HTTP Bearer token.
The runtime requires the literal Bearer prefix — a bare token in the
Authorization header is rejected with 401 unauthorized.
Header Format: Authorization: Bearer YOUR_API_KEY
Your API key is a JWT. Live keys operate on live data (livemode: true);
test keys operate on isolated test data (livemode: false).
Get your key at: app.gigstack.pro/settings?tab=api
Errors: credential failures are answered by the authentication layer with a raw
{ "message": … } body, not the standardized envelope — 401 for a missing, malformed or
expired token, 403 for a revoked key or a plan without API access. See the Unauthorized
and AuthForbidden responses.
Path Parameters
Retention UUID
Query Parameters
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a
team other than the one your API key belongs to return 403 without it.
Only API keys can use it: an OAuth access token sent with another team's id is rejected with
403 Team mismatch with OAuth token.
Optional — omit it entirely unless you are acting on another team. It deliberately
carries no example value so generated snippets do not emit ?team=undefined; when the
parameter is absent, the team is derived from your API key.
Example: ?team=team_xyz789
Response
Retention retrieved successfully
Standardized success envelope emitted by sendSuccessResponse.
true true
The operation payload.
Server time in epoch milliseconds (Luxon.now().toMillis()).
1767225600000
Human-readable summary. Present only when the handler supplies one.
"Operation completed successfully"