List Container

The List Containers endpoint returns all containers associated with a specific user.

This allows your application to retrieve container metadata, track created containers, and manage container lifecycle.

This endpoint does not return decrypted file contents.

Endpoint

GET /users/{user_id}/containers

Base URL:

https://share.locktera.com/api/v1

Full request URL example:

https://share.locktera.com/api/v1/users/USER_ID/containers

Authentication

All requests must include a valid API key in the Authorization header.

Example request:

curl -X GET $BASE_URL/users/YOUR_USER_ID/containers \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication is verified before container metadata is returned.

Path Parameters

user_id
Required. The unique identifier of the user whose containers will be listed.

Example:

123e4567-e89b-12d3-a456-426614174000

The requesting API key must have permission to access containers associated with this user_id.

Example Success Response

{
  "containers": [
    {
      "container_id": "123e4567-e89b-12d3-a456-426614174000",
      "container_name": "example_container",
      "created_date": "2026-02-19T18:42:00Z",
      "sender": "user@company.com"
    },
    {
      "container_id": "123e4567-e89b-12d3-a456-426614174000",
      "container_name": "financial_report",
      "created_date": "2026-02-20T10:15:00Z",
      "sender": "user@company.com"
    }
  ]
}

Response Fields

containers
An array of container objects.

Each container object includes:

id
Unique identifier of the container.

container_name
Name assigned when the container was created.

created_date
Timestamp when the container was created.

sender
User who created the container.

Example Error Responses

HTTP 401 Unauthorized

{
  "error": "unauthorized",
  "message": "Invalid API key"
}

HTTP 403 Forbidden

{
  "error": "access_denied",
  "message": "You do not have permission to list containers for this user"
}

HTTP 404 Not Found

{
  "error": "not_found",
  "message": "User not found"
}

What This Endpoint Is Used For

This endpoint is commonly used to:

• Retrieve all containers created by a user
• Display container lists in applications
• Track container creation
• Manage container lifecycle
• Retrieve container IDs for further operations

Important Notes

• This endpoint returns metadata only
• It does not return encrypted or decrypted file contents
• A valid API key with appropriate permissions is required

Results may be paginated for users with many containers. See pagination parameters for details.

Related Endpoints

Get Container Metadata

GET /users/{user_id}/containers/{container_id}

Encode Container

POST /users/{user_id}/containers/encode

Delete Container

DELETE /users/{user_id}/containers/{container_id}