Skip to main content
GET
/
api
/
v1
/
realms
/
{realmId}
/
currencies
Get Currencies
curl --request GET \
  --url https://api.drip.re/api/v1/realms/{realmId}/currencies \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "realmId": "<string>",
      "emoji": "<string>",
      "customEmojiUrl": "<string>",
      "default": false,
      "metadata": {},
      "scopes": [
        "<string>"
      ],
      "archived": false,
      "archivedAt": "2023-11-07T05:31:56Z",
      "ownership": "OWNED",
      "shareStatus": "PENDING",
      "parentRealmId": "<string>",
      "parentRealmName": "<string>",
      "permissions": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key

Path Parameters

​
realmId
string
required

Query Parameters

​
page
number
default:1

Page number (1-based)

Required range: x >= 1
​
limit
number
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
search
string

Search query to filter results

​
sortBy
string

Field to sort by

​
sortOrder
enum<string>
default:asc

Sort order (ascending or descending)

Available options:
asc,
desc
​
includeArchived
boolean
default:false

Include archived currencies in results

​
status
enum<string>

Filter by currency status

Available options:
active,
archived
​
isDefault
boolean

Filter by default currency status

Response

Default Response

​
data
object[]
required