List collection access requests

GET

https://api.sureshake.com/v2/entities/{entityId}/vault/access-requests

Path parameters

entityId
string
required
format: uuid

Query parameters

status
optional
pending
or
approved
or
rejected
or
cancelled
limit
optional
number
maximum: 100 · minimum: 1 · default: 50
offset
optional
number
minimum: 0 · default: 0

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- collectionId
  string
  required
  format: uuid
- requesterUserId
  string
  required
- requesterEntityId
  string
  or null
  required
  format: uuid
- status
  pending
  or
  approved
  or
  rejected
  or
  cancelled
  required
- tokenNetwork
  base-mainnet
  required
- tokenGrantStatus
  not_requested
  or
  pending
  or
  granted
  or
  revoked
  or
  failed
  required
- tokenGrantJobId
  string
  or null
  required
- tokenGrantAttempts
  integer
  required
  minimum: 0
- tokenGrantLastError
  string
  or null
  required
- tokenGrantLastAttemptAt
  string
  or null
  required
  format: date-time
- tokenGrantCompletedAt
  string
  or null
  required
  format: date-time
- requestNote
  string
  or null
  required
- reviewNotes
  string
  or null
  required
- reviewedBy
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- requester
  object
  required
  id
  string
  required
  name
  string
  required
  email
  string
  required
  format: email
  company
  string
  or null
  required
  title
  string
  or null
  required
  avatar
  string
  or null
  required
- requesterEntity
  object
  or null
  required
  id
  string
  required
  format: uuid
  name
  string
  required
  slug
  string
  or null
  required
  logoUrl
  string
  or null
  required
- collection
  object
  required
  id
  string
  required
  format: uuid
  name
  string
  required
  description
  string
  or null
  required
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

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
}

503

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": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "requesterUserId": "string", "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509", "status": "pending", "tokenNetwork": "base-mainnet", "tokenGrantStatus": "not_requested", "tokenGrantJobId": "string", "tokenGrantAttempts": 0, "tokenGrantLastError": "string", "tokenGrantLastAttemptAt": "2019-08-24T14:15:22Z", "tokenGrantCompletedAt": "2019-08-24T14:15:22Z", "requestNote": "string", "reviewNotes": "string", "reviewedBy": "string", "reviewedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "requester": { "id": "string", "name": "string", "email": "user@example.com", "company": "string", "title": "string", "avatar": "string" }, "requesterEntity": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "logoUrl": "string" }, "collection": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string" } } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }