List the additional entities on a transaction

Production

https://api.polestar-production.com

GET

/purpletrac/v1/transaction/{id}/additional_entity

Retrieve the additional entities which are currently tracked on a transaction. Entities which have been removed are excluded, and the results are ordered by id.

This method requires the Additional Entity Ship Tracking feature to be enabled on the account. Unlike the PUT and DELETE methods it can be called regardless of the transaction status.

Note that this method does not use the standard meta/objects pagination envelope, and supports no filtering or ordering parameters.

Refer to Managing Additional Entities to see how to use this endpoint in a vessel tracking workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The additional entities currently active on the transaction, each with the id the DELETE method takes. Removed entities are left out.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/purpletrac/v1/transaction//additional_entity?username=undefined&api_key=%3Capi-key%3E'

Response Example

200 - Default

{
    "additional_entities": [
        {
            "id": 4521,
            "name": "Hello Bank!",
            "relationship": "Financier",
            "type": "organisation",
            "obj_id": 1039902,
            "not": []
        }
    ]
}

Modified at 2026-09-18 08:35:54

Add additional entities to a tracked vessel

Update voyage and tracking details