Get Associated Attachments From Project

Retrieves all matching protected documents (attachments) under a specific user by searching with up to 3 keywords. Useful for filtering and accessing project-related files that are protected.

HTTP Method and URL

GET {{host}}/api/v2/projects/protect

Authentication Requirements

Requires a valid user token. Set the user-token variable in your environment or as a header.

Query Parameters

• user_type (string, required): Specifies the type of user. Example: ENTERPRISE_API

• keyword[sample_1] (string, required): First keyword to search for.

• keyword[sample_2] (string, optional): Second keyword to search for.

• keyword[sample_3] (string, optional): Third keyword to search for.

Example Request

GET {{host}}/api/v2/projects/protect?user_type=ENTERPRISE_API&keyword[sample_1]=Certificate
Headers:
  user-token: {USER-TOKEN}

Example Successful Response

{
  "message": "Success",
  "data": [
    {
      "id": 123,
      "project_uuid": "abc-123-xyz",
      "reference_number": "REF-001",
      "type": "document",
      "category": "certificate",
      "status": "protected",
      "name": "Sample Certificate",
      "file_name": "certificate.pdf",
      "project_file_id": 456,
      "storage": "s3",
      "path": "/files/certificate.pdf",
      "dna": "unique-dna-string",
      "project_file_meta": "{...}",
      "blockchain_id": 789,
      "blockchain_uuid": "blockchain-uuid",
      "event": "upload",
      "network": "mainnet"
    }
  ]
}

Error Responses

• 400 Bad Request: Missing or invalid parameters.

• 401 Unauthorized: Invalid or missing authentication token.

• 404 Not Found: No matching documents found.

• 500 Internal Server Error: Unexpected server error.

Usage Notes

• You must provide at least one keyword (keyword[sample_1]).

• The user-token variable should be set in your environment for authentication.

• The endpoint supports searching with up to three keywords for more refined results.