Download OpenAPI specification:Download
{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "display_name": "John Doe",
- "authentication_provider": "sso",
- "authentication_provider_id": "abcd1234",
- "created_at": "2023-10-01T12:00:00Z",
- "updated_at": "2023-10-15T15:30:00Z",
- "role": "user",
- "phone_number": "+1234567890",
- "last_login": "2023-10-18T09:30:00Z",
- "status": "active",
- "open_id": "1234567890"
}
[- {
- "topic_id": "topic_12345",
- "headline": "Best City to Visit in 2024",
- "choice_id": "choice_001",
- "choice_label": "Paris",
- "gold_staked": 100,
- "voted_at": "2024-10-20T14:30:00Z"
}, - {
- "topic_id": "topic_54321",
- "headline": "Best Food in 2024",
- "choice_id": "choice_002",
- "choice_label": "Pizza",
- "gold_staked": 200,
- "voted_at": "2024-10-21T16:00:00Z"
}
]| amount | integer Amount of gold to purchase |
| purchase_token | string A token representing the in-app purchase (e.g., from the app store) |
| app_identifier | string The unique identifier of the app where the purchase was made |
| purchase_channel | string The channel used for the purchase (e.g., 'google_play', 'apple_app_store') |
{- "amount": 0,
- "purchase_token": "string",
- "app_identifier": "string",
- "purchase_channel": "string"
}{- "gold": 150
}| limit | integer Number of transactions to return (default: 10) |
| offset | integer Offset for pagination (default: 0) |
{- "transactions": [
- {
- "transaction_id": "tx_01",
- "type": "purchase",
- "amount": 100,
- "timestamp": "2024-10-18T10:00:00Z"
}, - {
- "transaction_id": "tx_02",
- "type": "spend",
- "amount": 50,
- "timestamp": "2024-10-19T12:00:00Z"
}
]
}| limit | integer Number of transactions to return (default: 10) |
| offset | integer Offset for pagination (default: 0) |
{- "transactions": [
- {
- "transaction_id": "tx_101",
- "type": "earn",
- "amount": 70,
- "timestamp": "2024-10-18T11:00:00Z"
}, - {
- "transaction_id": "tx_102",
- "type": "spend",
- "amount": 30,
- "timestamp": "2024-10-19T13:00:00Z"
}
]
}| tags | Array of strings |
| sort | string Enum: "largest_gold" "largest_voters" "latest" "oldest" |
[- {
- "topic_id": "topic_12345",
- "headline": "Best City to Visit in 2024",
- "status": "voting",
- "gold_staked": 1000,
- "voters_count": 50
}, - {
- "topic_id": "topic_54321",
- "headline": "Best Food in 2024",
- "status": "reviewing",
- "gold_staked": 500,
- "voters_count": 20
}
]| headline | string Title of the voting topic |
| description | string Details about the topic |
| result_measurement_method | string Method to measure the result |
| result_date | string <date-time> Date when the result will be announced |
| related_resources | Array of strings <uri> [ items <uri > ] |
{- "headline": "Best City to Visit in 2024",
- "description": "Vote for the best travel destination city for 2024.",
- "result_measurement_method": "majority",
- "result_date": "2024-12-31T23:59:59Z",
}{- "topic_id": "topic_12345",
- "status": "reviewing",
- "creator": {
- "user_id": "user_67890",
- "display_name": "John Doe"
}
}| topic_id required | string |
| choice_label | string Human-readable label for the choice |
| choice_description | string Detailed description of the choice |
{- "choice_label": "Paris",
- "choice_description": "The city of lights, known for its culture and history."
}{- "choice_id": "choice_001"
}| topic_id required | string |
{- "topic_id": "topic_12345",
- "headline": "Best City to Visit in 2024",
- "description": "Vote for the best travel destination city for 2024.",
- "creator": {
- "user_id": "user_67890",
- "display_name": "John Doe"
}, - "result_measurement_method": "majority",
- "result_date": "2024-12-31T23:59:59Z",
- "result": {
- "choice_id": "choice_001",
- "result_set_by": {
- "user_id": "user_67890",
- "display_name": "John Doe"
}, - "result_set_at": "2024-12-25T12:00:00Z",
- "is_appealed": true
}, - "result_history": [
- {
- "status": "result_set",
- "result_choice_id": "choice_001",
- "by": {
- "user_id": "user_67890",
- "display_name": "John Doe"
}, - "at": "2024-12-24T12:00:00Z"
}, - {
- "status": "result_approve",
- "by": {
- "user_id": "admin_123",
- "display_name": "Admin 1"
}, - "at": "2024-12-25T14:00:00Z"
}, - {
- "status": "appeal",
- "by": {
- "user_id": "user_54321",
- "display_name": "Jane Doe"
}, - "at": "2024-12-26T10:00:00Z"
}, - {
- "status": "result_set",
- "result_choice_id": "choice_002",
- "by": {
- "user_id": "user_67890",
- "display_name": "John Doe"
}, - "at": "2024-12-27T12:00:00Z"
}, - {
- "status": "result_approve",
- "by": {
- "user_id": "admin_123",
- "display_name": "Admin 1"
}, - "at": "2024-12-27T14:00:00Z"
}, - {
- "status": "finalized",
- "by": {
- "user_id": "system_123",
- "display_name": "System"
}, - "at": "2024-12-28T10:00:00Z"
}
], - "choices": [
- {
- "choice_id": "choice_001",
- "choice_label": "Paris",
- "choice_description": "The city of lights, known for its culture and history."
}, - {
- "choice_id": "choice_002",
- "choice_label": "Tokyo",
- "choice_description": "A bustling metropolis with modern and traditional attractions."
}
], - "status": "voting",
- "gold_staked": 1000,
- "voters_count": 50,
}| topic_id required | string |
| result_choice_id | string The ID of the choice that is the result |
{- "result_choice_id": "choice_001"
}{- "result_choice_id": "choice_001"
}| topic_id required | string |
| choice_id | string ID of the choice |
| gold_staked | number Number of gold to be staked |
{- "choice_id": "string",
- "gold_staked": 0
}{- "highest_reward": 500
}| topic_id required | string |
| choice_id | string The ID of the choice the user is voting for |
| gold_staked | integer Amount of gold the user is staking |
{- "choice_id": "choice_001",
- "gold_staked": 100
}{- "vote_id": "vote_54321"
}| topic_id required | string |
| reason | string The reason for appealing the result |
{- "reason": "The result doesn't reflect the majority's vote."
}{- "status": "pending"
}| topic_id required | string |
| result_choice_id | string The ID of the choice that is the result |
{- "result_choice_id": "choice_001"
}{- "result_choice_id": "choice_001"
}| topic_id required | string |
| choice_id | string ID of the choice |
| gold_staked | number Number of gold to be staked |
{- "choice_id": "string",
- "gold_staked": 0
}{- "highest_reward": 500
}| topic_id required | string |
| action | string Enum: "approve" "deny" Action to approve or deny the topic |
{- "action": "approve"
}{- "status": "voting"
}| topic_id required | string |
| action | string Enum: "approve" "deny" Action to approve or deny the result |
{- "action": "approve"
}{- "status": "approved"
}| user_id | string The ID of the user to add as a friend |
{- "user_id": "user_12345"
}{- "status": "User added to friend list"
}[- {
- "gift_id": "gift_001",
- "gift_name": "Golden Trophy",
- "price_in_diamonds": 50,
- "gold_reward": 100
}, - {
- "gift_id": "gift_002",
- "gift_name": "Silver Medal",
- "price_in_diamonds": 30,
- "gold_reward": 60
}
]| gift_id required | string |
| recipient_user_id | string The ID of the friend receiving the gift |
{- "recipient_user_id": "user_67890"
}{- "status": "Gift sent successfully"
}[- {
- "gift_id": "gift_001",
- "gift_name": "Golden Trophy",
- "sender_user_id": "user_12345",
- "sender_display_name": "John Doe",
- "gold_reward": 100
}, - {
- "gift_id": "gift_002",
- "gift_name": "Silver Medal",
- "sender_user_id": "user_67890",
- "sender_display_name": "Jane Smith",
- "gold_reward": 60
}
]