GET /v1/vaults/{resourceId}/share-mobility

Availability	Private Preview
Method and path	`GET /v1/vaults/{resourceId}/share-mobility`
API version	`1.0.0-private-preview`
Base URL	`https://api.torq.finance`
Authentication	Anonymous discovery
Idempotency	Not declared by this operation.
Rate limits	Read `x-ratelimit-*` and `x-request-id` response headers. Do not hard-code a quota.

Request examples

terminal

curl -X GET 'https://api.torq.finance/v1/vaults/sample_resourceid/share-mobility' \
  -H 'Accept: application/json'

Run a safe sample

This calls the docs preview and returns sample data shaped by the governed OpenAPI response. It never accepts credentials or changes protocol state.

Run the sample call to inspect a schema-shaped response without credentials or side effects.

Request body	None.

Parameters

Name	In	Required	Type
`resourceId`	path	Yes	`string`

Responses

Status	Meaning	Schema
`200`	Successful response	`VaultShareMobilityResource`
`400`	Invalid request	`TorqApiError`
`401`	Authentication required	`TorqApiError`
`403`	Insufficient scope or authority	`TorqApiError`
`409`	State or idempotency conflict	`TorqApiError`
`429`	Rate limit exceeded	`TorqApiError`
`500`	Internal failure	`TorqApiError`

200 response schema

VaultShareMobilityResource VaultShareMobilityResource

Property	Type	Required	Description
`vaultId`	`string`	No	—
`vaultAddress`	`string`	No	—
`transferProfile`	`string \| null`	No	—
`shareMobilityPaused`	`boolean \| null`	No	—
`restoreAfter`	`string \| null (date-time)`	No	—
`redeemFreezeReason`	`string \| null`	No	—
`systemReason`	`string \| null`	No	—
`mobilityEpoch`	`string \| null`	No	—
`shareTokens`	`object[]`	No	—
`redemptionQueue`	`object`	No	—
`trustedRecipientPolicy`	`object`	No	—
`walletEligibility`	`object`	No	—

Inspect nested properties

vaultId string · optional

vaultAddress string · optional

pattern: ^0x[a-fA-F0-9]{40}$

transferProfile string | null · optional

nullable

shareMobilityPaused boolean | null · optional

nullable

restoreAfter string | null (date-time) · optional

nullable

redeemFreezeReason string | null · optional

nullable

systemReason string | null · optional

nullable

mobilityEpoch string | null · optional

pattern: ^[0-9]+$ · nullable

shareTokens object[] · optional

items object

Property	Type	Required	Description
`tokenAddress`	`string`	No	—
`shareClass`	`string`	No	—
`name`	`string`	No	—
`symbol`	`string`	No	—
`decimals`	`integer`	No	—
`transferable`	`boolean`	No	—
`supportsAllowance`	`boolean`	No	—
`supportsAdapters`	`boolean`	No	—
`totalSupply`	`string \| null`	No	—

Inspect nested properties

tokenAddress string · optional

pattern: ^0x[a-fA-F0-9]{40}$

shareClass string · optional

name string · optional

symbol string · optional

decimals integer · optional

transferable boolean · optional

supportsAllowance boolean · optional

supportsAdapters boolean · optional

totalSupply string | null · optional

pattern: ^[0-9]+$ · nullable

redemptionQueue object · optional

trustedRecipientPolicy object · optional

walletEligibility object · optional

400, 401, 403, 409, 429, 500 response schema

TorqApiError TorqApiError

Property	Type	Required	Description
`ok`	`boolean`	Yes	—
`code`	`string`	Yes	—
`message`	`string`	Yes	—
`requestId`	`string`	Yes	—
`retryable`	`boolean`	Yes	—
`blockedReason`	`string \| null`	No	—
`docsUrl`	`string (uri)`	No	—

Inspect nested properties

ok boolean · required

code string · required

minimum length: 1 · maximum length: 200

message string · required

minimum length: 1 · maximum length: 200

requestId string · required

minimum length: 1 · maximum length: 200

retryable boolean · required

blockedReason string | null · optional

nullable

docsUrl string (uri) · optional

Related guides

For retry behavior and blocked-state handling, see Errors and rate limits.