List vault passes

GET

https://api.sureshake.com/v2/entities/{entityId}/collections/{id}/vault/passes

Path parameters

entityId
string
required
format: uuid

id
string
required
format: uuid

Query parameters

status
optional
pending
or
active
or
failed
or
revoking
or
revoked
limit
optional
integer
maximum: 200 · minimum: 1 · default: 50
offset
optional
integer
minimum: 0 · default: 0

Returns

200

Default Response

JSON

data
object
required
- passes
  array of
  object
  required
  id
  string
  required
  format: uuid
  recipientUserId
  string
  required
  recipientName
  string
  or null
  required
  walletAddress
  string
  or null
  required
  status
  pending
  or
  active
  or
  failed
  or
  revoking
  or
  revoked
  required
  transactionHash
  string
  or null
  required
  revokeTransactionHash
  string
  or null
  required
  explorerUrl
  string
  or null
  required
  format: uri
  lastError
  string
  or null
  required
  grantedAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
- total
  integer
  required
  minimum: 0
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": { "passes": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "recipientUserId": "string", "recipientName": "string", "walletAddress": "string", "status": "pending", "transactionHash": "string", "revokeTransactionHash": "string", "explorerUrl": "http://example.com", "lastError": "string", "grantedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0 }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }