Ctrl+K

List Network Partners

get/api/stablecoin/v1/admin/network-partners

Retrieves a list of all network partners for administrative purposes.

Query Parameters

  • pageNostring<number>
    Page number for paginated results
    Example: 1
  • pageSizestring<number>
    Number of network partners per page
    Example: 20
  • enterpriseIdstring
    Filter by enterprise identifier
    Example: 04a54c3c9b75655cf1d587f0a5713aa8
    Min length: >= 1 characters
  • organizationIdstring
    Filter by organization identifier
    Example: 6437d9ae435d8b0007635c3f0db52154
    Min length: >= 1 characters
  • createdAtTostring<number>
    End timestamp for creation date filter (Unix timestamp)
    Example: 1687500000
  • createdAtFromstring<number>
    Start timestamp for creation date filter (Unix timestamp)
    Example: 1687413600
  • entitystring
    Filter by network partner entity type
    Example: EXCHANGE
    Enum: EXCHANGE MARKET_MAKER
  • statusstring
    Filter by network partner status
    Example: ACTIVE
    Enum: ACTIVE INACTIVE BLOCKED

200 Response

data array[object] required
List of network partners
id string <uuid>required
Unique identifier for the network partner
Example: ca1bf54a-15e7-453d-818b-7664abd8b98a
enterpriseId string required
Enterprise ID associated with the network partner
Min length: >= 1 characters
Example: 6437d9ae435d8b0007635c3f0db52154
Match pattern: ^[0-9a-f]{32}$
walletId string required
Wallet ID used for transactions
Min length: >= 1 characters
Example: 6437d9f07d6a87000613e6c06e4218d3
Match pattern: ^[0-9a-f]{32}$
address string required
Blockchain address of the network partner
Min length: >= 1 characters
Example: 0x80fce09234d855b7508c024a4f14cb01eaaedb6d
Match pattern: ^[0-9a-f]{32}$
entity string required
Type of entity the network partner represents
Allowed values: EXCHANGE MARKET_MAKER
Example: EXCHANGE
organizationId string
Organization identifier
Min length: >= 1 characters
description string
Additional details about the network partner
Example: testing
networkPartnerName string
Display name of the network partner
networkPartnerLogoUrl string
URL to the network partner's logo
networkPartnerWebsiteUrl string
URL to the network partner's website
isNetworkPartnerFeatured boolean required
Indicates if the network partner is featured
Example: false
hasAgreedToTermsAndConditions boolean required
Indicates if the partner has agreed to terms and conditions
Example: false
estimatedAssetHolding number required
Estimated asset holding value
Example: 1000
status string required
Current status of the network partner
Allowed values: ACTIVE INACTIVE BLOCKED
Example: ACTIVE
updatedBy string required
ID of the user who last updated the record
Min length: >= 1 characters
Example: 628ca09d1b78a6000750274f0775571a
Match pattern: ^[0-9a-f]{32}$
comment string
Comments or notes
activatedAt string <date-time>
Timestamp when the partner was activated
createdAt string <date-time>required
Timestamp when the record was created
updatedAt string <date-time>required
Timestamp when the record was last updated
allTimeRevenueDetails object
Revenue details aggregated over all time
monthlyRevenueDetails array[object]
Monthly breakdown of revenue details
total number required
Total number of network partners

400 Response

500 Response