Packages

The MASV API allows authorized users to manage packages that have been sent and received under their account.

Listing sent packages

Users can retrieve a list of packages in a Team that meets specific criteria, subject to the MASV access policy.

This endpoint returns a list of packages that were sent to a Team. To retrieve a list of packages received from a Portal, see Listing Portal packages.

Method	Route
`GET`	`/v1.1/teams/{team_id}/packages`

Headers

Name	Type	Required	Description
`X-API-KEY`	String	Yes	API key
`Content-Type`	String	Yes	Must be `application/json`

Query parameters

Name	Type	Required	Description
`page`	Integer	Yes	Page number. Default: `1`
`limit`	Integer	Yes	Records per page, 1–50. Default: `50`
`sort`	String	No	Sort ascending (`fieldname`) or descending (`-fieldname`). Accepted: `name`, `created_at`, `size`, `usage_total_bytes`, `expiry`, `sender`, `status`, `teamspace_id`
`status`	String[]	No	Filter by state: `new`, `finalized`, `expired`, `archived`. Default: `[finalized, expired]`
`name`	String	No	Substring match on package name
`sender`	String	No	Match sender email
`tags`	String	No	Comma-separated tag IDs
`created_at_start`	String	No	Created after date. Format: ISO 8601
`created_at_end`	String	No	Created before date. Format: ISO 8601
`teamspaces`	String	No	Comma-separated Teamspace IDs
`expiry_start`	String	No	Expires after date
`expiry_end`	String	No	Expires before date
`extra_storage`	Boolean	No	Filter by extra storage usage

Path parameters

Name	Type	Required	Description
`team_id`	String	Yes	The Team ID

Request

curl -H "Content-Type: application/json" \
  -H "X-API-KEY: $API_KEY" \
  -X GET "https://api.massive.app/v1.1/teams/$TEAM_ID/packages?page=1&limit=3"

Response

Returns 200 OK:

{
  "metadata": {
    "total": 34
  },
  "records": [
    {
      "access_limit": 3,
      "access_token": "...",
      "contains_virus": false,
      "created_at": "2022-11-01T20:09:48.249Z",
      "description": "Good day to you",
      "expiry": "2022-11-06T20:09:48.175Z",
      "id": "E1XGADMXPSLEE9NGH7WRWJ069D",
      "name": "Delta's Team - 202211012009",
      "sender": "[email protected]",
      "size": 41610,
      "state": "expired",
      "total_files": 1
    }
  ]
}

Property	Description
`metadata`	Contains `total` — the total number of matching packages
`records`	Array of up to `limit` package objects

Changing the name

Method	Route
`PUT`	`/v1/packages/{package_id}`

Headers

Name	Type	Required	Description
`X-Package-Token`	String	Yes	Package access token
`Content-Type`	String	Yes	Must be `application/json`

Body

Name	Type	Required	Description
`name`	String	Yes	Name for the package

Request

curl -d '{"name": "$NAME"}' \
  -H "X-Package-Token: $PACKAGE_TOKEN" \
  -H "Content-Type: application/json" \
  -X PUT https://api.massive.app/v1/packages/$PACKAGE_ID

Response

Returns 200 OK with the updated package object.

Changing the expiry

MASV stores an uploaded package until its expiry time. When it expires, MASV deletes the package. Expired packages cannot be downloaded and links do not give access to the package.

Method	Route
`PUT`	`/v1/packages/{package_id}/expiry`

Headers

Name	Type	Required	Description
`X-Package-Token`	String	Yes	Package access token
`Content-Type`	String	Yes	Must be `application/json`

Body

Name	Type	Required	Description
`expiry`	String	Yes	Date-time expiry. Format: ISO 8601
`unlimited_storage`	Boolean	No	If `true`, omit `expiry` from the request. Default: `false`

Request

curl -d '{"expiry": "$EXPIRY"}' \
  -H "X-Package-Token: $PACKAGE_TOKEN" \
  -H "Content-Type: application/json" \
  -X PUT https://api.massive.app/v1/packages/$PACKAGE_ID/expiry

Response

Returns 200 OK with the updated package object.

Deleting a package

When MASV deletes a package, it deletes the package’s files and custom metadata from MASV storage. It keeps the package’s name, recipient list, and related information, and sets the package’s state to expired.

Method	Route
`DELETE`	`/v1/packages/{package_id}`

Headers

Name	Type	Required	Description
`X-Package-Token`	String	Yes	Package access token

Request

curl -H "X-Package-Token: $PACKAGE_TOKEN" \
  -X DELETE https://api.massive.app/v1/packages/$PACKAGE_ID

Response

Returns 204 No Content.

Archiving expired packages

Authorized users can archive or unarchive any package that was previously in an expired state. The unarchive endpoint puts the package back to an expired state.

Method	Route
`PUT`	`/v1/packages/{package_id}/archive`
`PUT`	`/v1/packages/{package_id}/unarchive`

Request

curl -H "X-Package-Token: $PACKAGE_TOKEN" \
  -H "Content-Type: application/json" \
  -X PUT https://api.massive.app/v1/packages/$PACKAGE_ID/archive

Response

Returns 204 No Content.

Archiving sent packages (bulk)

Archive or unarchive multiple expired packages sent by the Team within a date range.

Method	Route
`PUT`	`/v1/teams/{team_id}/archive`
`PUT`	`/v1/teams/{team_id}/unarchive`

Body

Name	Type	Required	Description
`expiry_start`	String	Yes	Earliest package expiry date-time
`expiry_end`	String	Yes	Latest package expiry date-time

Request

curl -d '{"expiry_start": "$EXPIRY_START", "expiry_end": "$EXPIRY_END"}' \
  -H "X-API-KEY: $API_KEY" \
  -H "Content-Type: application/json" \
  -X PUT https://api.massive.app/v1/teams/$TEAM_ID/archive

Response

Returns 200 OK:

{
  "total_updated": 51
}

Archiving received packages (bulk)

Archive or unarchive multiple expired packages received through a Portal.

Method	Route
`PUT`	`/v1/teams/{team_id}/inbox/archive`
`PUT`	`/v1/teams/{team_id}/inbox/unarchive`

Same body and response format as archiving sent packages above.

Package object

Property	Type	Description
`access_limit`	Integer	Default access limit for new links
`access_token`	String	Access token for managing the package
`contains_virus`	Boolean	Whether the package contains a virus
`created_at`	String	Creation date-time (ISO 8601)
`custom_expiry`	Boolean	Whether a custom expiry was set
`custom_metadata_id`	String	ID of the associated form response
`description`	String	Package description
`expiry`	String	Expiry date-time (ISO 8601)
`id`	String	Unique package ID
`name`	String	Package name
`password`	String	Default password for new links (empty if none)
`recipients`	String[]	Recipient email addresses
`sender`	String	Sender’s email address
`size`	Integer	Package size in bytes
`state`	String	Status: `new`, `finalized`, `expired`, or `archived`
`teamspace`	Object	The Teamspace the package belongs to
`total_files`	Integer	Number of files in the package
`unlimited_storage`	Boolean	Whether unlimited storage is enabled
`updated_at`	String	Last modified date-time
`chunk_size`	Integer	Chunk size in bytes for file uploads (0 if not specified)