Skip to main content
GET
/
autoramp-flow
/
list
Get autoramp flow list
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/autoramp-flow/list \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "uuid-12345",
        "type": "ONRAMP",
        "from": "67890",
        "to": "54321",
        "status": "ENABLED",
        "createTime": "2024-01-01T00:00:00Z"
      }
    ],
    "total": 123,
    "pageNum": 123,
    "pageSize": 123
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

pageNum
number
default:1

Page number

Required range: x >= 1
pageSize
number
default:10

Page size

Required range: 1 <= x <= 100
type
enum<string>

Flow type

Available options:
ONRAMP,
OFFRAMP
Example:

"ONRAMP"

status
enum<string>

Flow status

Available options:
ENABLED,
DISABLED
Example:

"ENABLED"

Response

Get autoramp flow list successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data