Passports

List passports.

Paginated list of passports the workspace owns. Filter by product, status, or a free-text search across GTIN and serial.

get/api/v1/passports

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/passports
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.tracepass.eu/api/oauth/authorize, token URL https://app.tracepass.eu/api/oauth/token, scopes: passports:read)

Query parameters

pageinteger
limitinteger
productIdstring

MongoDB ObjectId hex string (24 chars).

Example:6650a1b2c3d4e5f6a7b8c9d0
status'draft' | 'in_review' | 'approved' | 'published' | 'suspended' | 'expired' | 'archived'
searchstring

Response

Paginated passport list.

totalinteger required
pageinteger required
limitinteger required
totalPagesinteger required

Example response

{
  "items": [
    {
      "_id": "6650a1b2c3d4e5f6a7b8c9d0",
      "productId": "6650a1b2c3d4e5f6a7b8c9d0",
      "identifier": {
        "gtin": "04012345000015"
      },
      "gs1": {
        "gtin": "04012345000015",
        "serialNumber": "BP-48V-100-000001",
        "digitalLinkUri": "https://id.tracepass.eu/p/01/04012345000015/21/BP-48V-100-000001"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.