SMsmokeball
Matters

Get the archive for a matter

Retrieves an archive for a matter.

get/matters/{matterId}/archive

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/archive
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required

Response

When request is successful. Returns an 'Archive' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Matter Id.

archivedDatestring date-time

Date the matter was archived.

archiveBoxNumberstring nullable

Archive box number.

archiveCommentsstring nullable

Archive comments.

archivedLocationstring nullable

Archived location.

destroyDatestring date-time

Date the files of the matter were destroyed.

isArchivedboolean

Flag indicating if the matter is archived.

Example response

{
  "id": "f489b750-544e-4aa7-962e-f388b775bc14",
  "archivedDate": "2022-04-23T14:00:00Z",
  "archiveBoxNumber": "24",
  "archiveComments": "Lot 1",
  "archivedLocation": "Box",
  "destroyDate": "2022-04-29T14:00:00Z",
  "isArchived": true
}

Changes

No recorded changes to this operation across all 15 revisions of this API.