Skip to main content
GET
https://api.zipkit.io
/
api
/
v1
/
zips
/
:id
curl -X GET https://api.zipkit.io/v1/zips/clx7g2m4p0000xyz123abc \
  -H "Authorization: Bearer your-access-token"

{
  "data": {
    "uuid": "clx7g2m4p0000xyz123abc",
    "status": "succeeded",
    "metadata": {
      "user_id": "user_123",
      "order_id": "order_456"
    }
  }
}

​
Overview

Retrieve the current status of a zip creation job by its UUID. Use the uuid value returned from the POST /api/v1/zips endpoint.

​
Endpoint

GET /api/v1/zips/:id

​
Authentication

Requires a valid access token in the Authorization header: 
Authorization: Bearer YOUR_ACCESS_TOKEN
See Authentication for details.

​
Path Parameters

​
id
string
required
The UUID of the zip job returned when you created it (e.g., clx7g2m4p0000xyz123abc).This is the uuid value from the POST /api/v1/zips response.
curl -X GET https://api.zipkit.io/v1/zips/clx7g2m4p0000xyz123abc \
  -H "Authorization: Bearer your-access-token"

{
  "data": {
    "uuid": "clx7g2m4p0000xyz123abc",
    "status": "succeeded",
    "metadata": {
      "user_id": "user_123",
      "order_id": "order_456"
    }
  }
}
​
data
object
The response data object containing zip information.
​
data.uuid
string
Unique identifier (UUID) for this zip job.
​
data.status
string
Current status of the zip job.Possible values:
  • none - Job created, not yet started processing
  • processing - Currently downloading files and creating zip
  • succeeded - zip successfully created and uploaded to your bucket
  • failed - Job failed during processing
​
data.metadata
object
The custom metadata object that was provided when the zip was created. Returns an empty object {} if no metadata was provided.

​
Error Responses

All errors follow a consistent JSON format: 
{
  "error": {
    "type": "error_type",
    "code": "error_code",
    "message": "Human-readable description",
    "param": null
  }
}

​
401 Unauthorized

Returned when authentication fails.

​
Missing Authorization Header

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "No API key provided. Include your API key in the Authorization header using Bearer auth.",
    "param": null
  }
}

​
Invalid API Key

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "Invalid API key provided.",
    "param": null
  }
}

​
404 Not Found

Returned when the zip ID doesn’t exist or doesn’t belong to your project.

​
Notes

Webhooks recommended: Instead of polling this endpoint, configure a webhook to receive automatic notifications when zips complete. See the Webhooks guide for details.