1. refunds
1.1. id
1.2. campaign_id
1.3. client_id
1.4. processed_by
1.5. source
1.5.1. values
1.5.1.1. campaign_end
1.5.1.2. campaign_cancelled
1.5.1.3. manual
1.5.1.4. payment
1.6. related_deposit_id(optional)
1.7. status
1.7.1. type: ENUM
1.7.2. options:
1.7.2.1. none (No refund has been requested.)
1.7.2.2. requested (The customer has requested a refund, but it has not been processed yet.)
1.7.2.3. in_progress (The refund is being processed by the system or payment provider.)
1.7.2.4. partial ( partial refund has been issued, but the payment is not fully refunded.)
1.7.2.5. completed (The refund has been successfully processed and completed. Full Amount.)
1.7.2.6. failed (The refund attempt failed (e.g., due to technical or bank-related issues).)
1.7.2.7. rejected (The refund request was reviewed and denied (e.g., due to policy violations).)
1.7.2.8. canceled (The refund was initially requested but later canceled by the customer or support team.)
1.8. transaction_id(from payment provider)
1.9. payment_method(from payment provider)
1.9.1. values
1.9.1.1. card
1.9.1.2. wallet
1.10. reason
1.11. note
1.12. created_at
1.13. updated_at
1.14. amount
1.15. currency
2. deposit
2.1. id
2.2. campaign_id
2.3. client_id
2.4. transaction_id(from payment provider)
2.5. payment_method(from payment provider)
2.5.1. values
2.5.1.1. card
2.5.1.2. wallet
2.6. amount
2.7. currency
2.8. processed_by
2.9. refund_status
2.10. refund_amount
2.11. refund_id
2.12. note
2.13. created_at
2.14. updated_at
3. balance_transfer
3.1. id
3.2. task_id
3.3. order_id
3.4. creator_id
3.5. fund_source
3.5.1. values:
3.5.1.1. campaign_reserve
3.6. total_amount
3.7. currency
3.8. creator_share(goes to the creators_fund)
3.9. creator_transaction_id
3.10. platform_fee(goes to the platform revenue fund)
3.11. platform_transaction_id
3.12. status
3.12.1. pending
3.12.2. success
3.12.3. failed
3.13. failure_reason
3.13.1. creator_share_transaction_failed
3.13.2. platform_fee_transaction_failed
3.13.3. payment_provider_timeout
3.14. retries
3.14.1. number
3.15. created_at
3.16. updated_at
4. earning(created with a transfer)
4.1. id
4.2. creator_id
4.3. order_id
4.4. task_id
4.5. transfer_id
4.6. amount
4.7. currency
4.8. created_at
5. withdrawal
5.1. id
5.2. creator_id
5.3. amount
5.4. currency
5.5. transaction_id(from payment provider)
5.6. payment_provider
5.7. created_at
6. balance
6.1. id
6.2. creator_id
6.3. total_earned
6.4. available_balance
6.5. updated_at
7. promotion_application
7.1. id
7.1.1. type: int
7.2. creator_id
7.3. current_class
7.4. requested_class
7.5. created_at
7.6. updated_at
7.7. status
7.7.1. type: ENUM
7.7.2. options
7.7.2.1. panding
7.7.2.2. accepted
7.7.2.3. rejected
7.8. rejection_reason
7.9. reviewed_by
7.10. review_note
7.11. message
8. models
8.1. campaign
8.1.1. id
8.1.1.1. type: uuid
8.1.2. public_id
8.1.2.1. type: 6-digit number
8.1.3. owner_id
8.1.3.1. type: uuid
8.1.4. manager_id (ref to moderator)
8.1.4.1. type: uuid
8.1.5. title
8.1.5.1. type: text
8.1.6. status
8.1.6.1. type: ENUM
8.1.6.2. options
8.1.6.2.1. draft
8.1.6.2.2. review_scheduled
8.1.6.2.3. in_progress
8.1.6.2.4. completed
8.1.6.2.5. terminated
8.1.6.2.6. canceled
8.1.7. initial_payment_status
8.1.7.1. type: ENUM
8.1.7.2. options
8.1.7.2.1. due
8.1.7.2.2. completed
8.1.8. refund_status
8.1.8.1. type: ENUM
8.1.8.2. options:
8.1.8.2.1. none (No refund has been requested.)
8.1.8.2.2. requested (The customer has requested a refund, but it has not been processed yet.)
8.1.8.2.3. in_progress (The refund is being processed by the system or payment provider.)
8.1.8.2.4. partial ( partial refund has been issued, but the payment is not fully refunded.)
8.1.8.2.5. completed (The refund has been successfully processed and completed. Full Amount.)
8.1.8.2.6. failed (The refund attempt failed (e.g., due to technical or bank-related issues).)
8.1.8.2.7. rejected (The refund request was reviewed and denied (e.g., due to policy violations).)
8.1.8.2.8. canceled (The refund was initially requested but later canceled by the customer or support team.)
8.1.9. financial_timeline
8.1.9.1. object[]
8.1.9.2. for general stuff like adding funds and refunding excess
8.1.9.3. label
8.1.9.4. type
8.1.9.4.1. values
8.1.9.5. amount
8.1.9.6. deposit_id
8.1.9.7. refund_id
8.1.9.8. timestamp
8.1.10. created_at
8.1.10.1. type: timestampz
8.1.11. updated_at
8.1.11.1. type: timestampz
8.1.12. total_budget
8.1.13. total_spent_budget
8.1.14. total_allocated_budget
8.1.15. currency
8.1.16. orders
8.1.16.1. type: order(reference)[]
8.1.17. timeline
8.1.17.1. object[]
8.1.17.1.1. timestamp
8.1.17.1.2. type
8.1.17.1.3. label
8.1.17.1.4. metadata
8.1.17.2. campaign level events
8.1.17.2.1. campaign_created
8.1.17.2.2. campaign_paused(if allowed)
8.1.17.2.3. campaign_resumed(if allowed)
8.1.17.2.4. campaign_archived
8.1.17.2.5. campaign_terminated
8.1.17.2.6. campaign_archived
8.1.17.2.7. campaign_budget_updated
8.1.17.2.8. order_added
8.1.17.2.9. order_completed
8.2. pricing
8.2.1. creator_share_cap(what client pays)
8.2.1.1. type: number
8.2.2. total_price(what client pays)
8.2.2.1. type: number
8.2.3. platform_fee
8.2.3.1. type: number
8.2.4. currency
8.2.4.1. type: text or ENUM
8.2.5. discount
8.2.5.1. type
8.2.5.1.1. type: ENUM
8.2.5.1.2. options
8.2.5.2. value
8.2.5.2.1. type: number
8.2.5.3. creatot_deduction
8.2.5.3.1. type: number
8.2.5.4. platform_deduction
8.2.5.4.1. type: number
8.2.5.5. expiry_date
8.2.5.5.1. type: timestampz
8.3. order
8.3.1. id(if reference)
8.3.1.1. type: uuid
8.3.2. campaign_id (if reference)
8.3.2.1. type: uuid
8.3.3. title
8.3.3.1. type: text
8.3.4. status
8.3.4.1. values
8.3.4.1.1. awaiting allocations
8.3.4.1.2. in_progress
8.3.4.1.3. completed
8.3.4.1.4. terminated
8.3.5. type:
8.3.5.1. type: ENUM
8.3.5.2. options
8.3.5.2.1. video
8.3.5.2.2. image
8.3.6. ordered_quantity
8.3.6.1. type: number
8.3.7. delivered_quantity
8.3.7.1. type: number
8.3.8. product_info
8.3.8.1. name
8.3.8.1.1. type: text
8.3.8.1.2. required
8.3.8.2. descriprion
8.3.8.2.1. required
8.3.8.2.2. type: text
8.3.8.3. image_url
8.3.8.3.1. type: text
8.3.8.3.2. required
8.3.8.4. instructions
8.3.8.4.1. type: text
8.3.9. alloacted_budget
8.3.10. spent_budget
8.3.11. financial_timeline
8.3.11.1. object[]
8.3.11.2. mainly for task compensation
8.3.11.2.1. initial allocation
8.3.11.2.2. additional allocations
8.3.11.2.3. task payments
8.3.11.2.4. partial task payments
8.3.11.2.5. excess release
8.3.11.3. direction
8.3.11.3.1. values
8.3.11.4. label
8.3.11.5. amount
8.3.11.6. transfer_id
8.3.12. billing
8.3.12.1. type: pricing
8.3.13. video_requirements (if type == video)
8.3.13.1. type
8.3.13.1.1. type: reference (id or name)
8.3.13.2. duration
8.3.13.2.1. type: reference (id or value)
8.3.13.3. aspect_ratio
8.3.13.3.1. type: reference (id, value, or name)
8.3.14. creator_options
8.3.14.1. class
8.3.14.1.1. type: reference (id, value)
8.3.14.2. ages
8.3.14.2.1. type: text[] or ENUM[]
8.3.14.3. gender:
8.3.14.3.1. type: text or ENUM
8.3.14.4. preference
8.3.14.4.1. type: text
8.3.14.5. direct_requests(one request == one reserved slot == one video)
8.3.14.5.1. type: object[]
8.3.14.5.2. request_id
8.3.14.5.3. creator_id
8.3.14.5.4. status
8.3.15. add_ons
8.3.15.1. type: reference[] (id or name)
8.3.16. created_at
8.3.16.1. type: timestampz
8.3.17. updated_at
8.3.17.1. type: timestampz
8.3.18. additional_note
8.3.18.1. type(text)
8.3.19. delivered_assets
8.3.19.1. uuid[]
8.3.20. assigned_tasks: object[]
8.3.20.1. task_id
8.3.20.2. creator_id
8.3.20.3. status
8.3.20.3.1. ENUM
8.3.20.3.2. values:
8.3.20.4. final_asset_id
8.3.20.5. created_at
8.3.20.6. updated_at
8.3.20.7. rejection_reason
8.3.20.8. revision_count
8.3.21. open_for_bids
8.3.21.1. true once created if there are open slots for tasks
8.3.21.2. client can set it to false
8.3.21.3. to set it to true, a client needs and open slot and a suffecient budget
8.3.22. timeline
8.3.22.1. object[]
8.3.22.1.1. timestamp
8.3.22.1.2. type
8.3.22.1.3. label
8.3.22.1.4. metadata
8.3.22.2. all events
8.3.22.2.1. order_created
8.3.22.2.2. task_created
8.3.22.2.3. task_completed
8.3.22.2.4. task cancled
8.3.22.2.5. task_fail
8.3.22.2.6. order_terminated(with ongoing tasks)
8.3.22.2.7. order_canclled(before any commitment)
8.3.22.2.8. order_completed
8.4. assets
8.4.1. creator_id
8.4.1.1. type: uuid
8.4.2. id(if reference)
8.4.2.1. type: uuid
8.4.3. campaign_id (if reference)
8.4.3.1. type: uuid
8.4.3.2. nullable
8.4.4. owner_id (creator or campaign owner)
8.4.4.1. type: uuid
8.4.5. visibility
8.4.5.1. type: text or ENUM
8.4.5.2. values:
8.4.5.2.1. public
8.4.5.2.2. privatee
8.4.6. order_id
8.4.6.1. type: uuid
8.4.7. asset_url
8.4.7.1. type: text
8.4.8. thumbnail_url
8.4.8.1. type: text
8.4.9. asset_type
8.4.9.1. type: ENUM
8.4.9.2. options
8.4.9.2.1. video
8.4.9.2.2. image
8.4.10. catergories
8.4.10.1. type:: reference(id or name)
8.4.11. video_metadata (if asset_type == video) (match with the order)
8.4.11.1. type
8.4.11.1.1. type: reference (id or name)
8.4.11.2. duration
8.4.11.2.1. type: reference (id or value)
8.4.11.3. aspect_ratio
8.4.11.3.1. type: reference (id, value, or name)
8.4.12. status
8.4.12.1. type: text or ENUM
8.4.12.2. options
8.4.12.2.1. pending
8.4.12.2.2. approved
8.4.12.2.3. rejected
8.4.12.2.4. revision_requested
8.4.13. reviewed_by
8.4.13.1. type: uuid ( The person who approved/rejected)
8.4.14. review_comment
8.4.14.1. type: text
8.4.15. submitted_at
8.4.15.1. type: timestampz
8.4.16. reviewed_at
8.4.16.1. type: timestampz
8.4.17. version (increments on re-submission)
8.4.17.1. type: number
8.4.18. replaced_by_asset_id (Links to a new asset if this one is revised)
8.4.18.1. type: uuid
8.4.19. is_latest_version
8.4.19.1. type: boolean
8.5. asset_category
8.5.1. id
8.5.1.1. type: int
8.5.2. name
8.5.2.1. type: text
8.5.3. description
8.5.3.1. type: text
8.5.4. parent_id
8.5.4.1. type: int
8.5.4.2. For subcategories (nested categories)
8.5.5. is_available
8.5.5.1. type: boolean
8.6. reviews
8.6.1. id
8.6.1.1. type: int
8.6.2. target_type
8.6.2.1. type: ENUM
8.6.2.2. options
8.6.2.2.1. asset
8.6.2.2.2. creator
8.6.3. target_id
8.6.3.1. type: uuid
8.6.4. author_id
8.6.4.1. type: uuid
8.6.5. rating
8.6.5.1. type: number
8.6.6. comment
8.6.6.1. type: text
8.6.7. created_at
8.6.7.1. type: timestampz
8.6.8. updated_at
8.6.8.1. type: timestampz
8.7. video_type
8.7.1. id
8.7.1.1. type: int
8.7.2. value
8.7.2.1. type: text
8.7.3. name
8.7.3.1. type: text
8.7.4. price
8.7.4.1. type: pricing
8.7.5. display_order
8.7.5.1. type: int
8.7.6. created_at
8.7.6.1. type: timestamp
8.7.7. display_data
8.7.7.1. image_url
8.7.7.1.1. type: text
8.7.7.2. heading
8.7.7.2.1. type: text
8.7.7.3. description
8.7.7.3.1. type: text
8.7.7.4. perks
8.7.7.4.1. type: text[]
8.8. video_duration
8.8.1. id
8.8.1.1. type: int
8.8.2. display_order
8.8.2.1. type: int
8.8.3. image_url
8.8.3.1. type: text
8.8.4. value (duration in seconds)
8.8.4.1. type: number
8.8.5. price
8.8.5.1. type: pricing
8.8.6. created_at
8.8.6.1. type: timestamp
8.9. video_aspect_ratio
8.9.1. id
8.9.1.1. type: int
8.9.2. value
8.9.2.1. type: text
8.9.3. name
8.9.3.1. type: text
8.9.4. display_order
8.9.4.1. type: int
8.9.5. image_url
8.9.5.1. type: text
8.9.6. description
8.9.6.1. type: text
8.9.7. created_at
8.9.7.1. type: timestamp
8.10. creator_class
8.10.1. id
8.10.1.1. type: int
8.10.2. value
8.10.2.1. type: text
8.10.3. display_order
8.10.3.1. type: int
8.10.4. is_available
8.10.4.1. type: boolean
8.10.5. image_url
8.10.5.1. type: text
8.10.6. description
8.10.6.1. type: text
8.10.7. price
8.10.7.1. type: pricing
8.10.8. updated_at
8.10.8.1. type: timestamp
8.10.9. created_at
8.10.9.1. type: timestamp
8.11. FAQ
8.11.1. location (page where it should be displayed)
8.11.1.1. type: text
8.11.2. id
8.11.2.1. type: int
8.11.3. display_order
8.11.3.1. type: int
8.11.4. question
8.11.4.1. type: text
8.11.5. answer
8.11.5.1. type: text
8.11.6. created_at
8.11.6.1. type: timestampz
8.11.7. updated_at
8.11.7.1. type: timestampz
8.12. creator_application(first time application)
8.12.1. id
8.12.1.1. type: int
8.12.2. created_at
8.12.2.1. type: timestamp
8.12.3. updated_at
8.12.3.1. type: timestamp
8.12.4. name
8.12.4.1. type: text
8.12.5. phone_number
8.12.5.1. type: text
8.12.6. status
8.12.6.1. type: ENUM
8.12.6.2. options
8.12.6.2.1. panding
8.12.6.2.2. accepted
8.12.6.2.3. rejected
8.12.7. profile_urls
8.12.7.1. type: text[]
8.12.8. message
8.12.8.1. type: text
8.12.9. reviewed_by
8.12.10. review_note
8.13. social_profile
8.13.1. id
8.13.1.1. type: int
8.13.2. name
8.13.2.1. type: text
8.13.3. url
8.13.3.1. type: text
8.13.4. platform
8.13.4.1. type: text
8.14. instruction
8.14.1. id
8.14.1.1. type: int
8.14.2. location (page where it should be displayed)
8.14.2.1. type: text
8.14.3. display_order
8.14.3.1. type: int
8.14.4. image_url
8.14.4.1. type: text
8.14.4.2. optional
8.14.5. title
8.14.5.1. type: text
8.14.6. texts
8.14.6.1. type: text
8.14.6.2. format: formatted text
8.15. service_type
8.15.1. id
8.15.1.1. type: int
8.15.2. value
8.15.2.1. type: text
8.15.3. created_at
8.15.3.1. type: timestamp
8.16. service
8.16.1. id
8.16.1.1. type: int
8.16.2. name
8.16.2.1. type: text
8.16.3. type
8.16.3.1. type: text or reference (id or value)
8.16.4. provider
8.16.4.1. type: text or reference (id or value)
8.16.5. display_order
8.16.5.1. type: int
8.16.6. price
8.16.6.1. type: pricing
8.16.7. created_at
8.16.7.1. type: timestamp
8.16.8. display_data
8.16.8.1. video_url
8.16.8.1.1. type: text
8.16.8.2. thumbnail_url
8.16.8.2.1. type: text
8.16.8.3. name
8.16.8.3.1. type: text
8.16.8.4. perks
8.16.8.4.1. type: text[]
8.16.8.4.2. formatted_text
8.17. service_provider
8.17.1. id
8.17.1.1. type: int
8.17.2. value
8.17.2.1. type: text
8.17.3. created_at
8.17.3.1. type: timestamp
8.18. user_profile
8.18.1. id
8.18.1.1. type: uuid
8.18.2. user_id
8.18.2.1. type: uuid
8.18.2.2. reference to the auth user
8.18.3. role
8.18.3.1. type: ENUM
8.18.3.2. values
8.18.3.2.1. admin
8.18.3.2.2. moderator
8.18.3.2.3. client
8.18.3.2.4. creator
8.18.4. phone_number
8.18.4.1. type: text
8.18.5. email
8.18.5.1. type: text
8.18.6. email_verified
8.18.6.1. type: text
8.18.7. created_at
8.18.7.1. type: timestampz
8.18.8. updated_at
8.18.8.1. type: timestampz
8.19. client
8.19.1. id
8.19.1.1. type: uuid
8.19.2. profile_id
8.19.2.1. type: uuid
8.19.3. name
8.19.3.1. type: text
8.19.4. avatar_url
8.19.4.1. type: text
8.20. creator
8.20.1. id
8.20.1.1. type: uuid
8.20.2. profile_id
8.20.2.1. type: uuid
8.20.3. full_name
8.20.3.1. type: text
8.20.4. username
8.20.4.1. type: text
8.20.5. profile_image_url
8.20.5.1. type: text
8.20.6. banner_image_url
8.20.6.1. type: text
8.20.7. bio
8.20.7.1. type: text
8.20.8. class
8.20.8.1. type: reference (id, value)
8.20.9. promotion_date
8.20.10. promotion_method
8.20.10.1. values
8.20.10.1.1. application
8.20.10.1.2. manual
8.20.11. rating
8.20.11.1. average
8.20.11.1.1. type: float
8.20.11.2. count
8.20.11.2.1. type: int
8.20.12. featured_content
8.20.12.1. reviews_ids
8.20.12.1.1. type: int[]
8.20.12.2. assets_ids
8.20.12.2.1. type: uuid[]
8.20.13. address
8.20.13.1. type: address
8.20.14. specialty (categories) (if class == premium)
8.20.14.1. type: text[] or list of references to categories
8.20.15. website_url
8.20.15.1. type: text
8.20.16. social_profiles
8.20.16.1. type: text[]
8.20.17. performance_metrics
8.20.17.1. tasks_total
8.20.17.1.1. type: int
8.20.17.2. tasks_succeeded
8.20.17.2.1. type: int
8.20.17.3. tasks_failed
8.20.17.3.1. type: int
8.20.17.4. consecutive_fails
8.20.17.5. tasks_succeeded_after_first_revision
8.20.17.5.1. type: int
8.20.17.6. tasks_succeeded_after_second_revision
8.20.17.6.1. type: int
8.20.17.7. tasks_failed_after_first_revision
8.20.17.7.1. type: int
8.20.17.8. tasks_failed_after_second_revision
8.20.17.8.1. type: int
8.20.17.9. first_revisions_requested
8.20.17.9.1. type: int
8.20.17.10. second_revisions_requested
8.20.17.10.1. type: int
8.20.17.11. campaigns_total
8.20.17.11.1. type: int
8.20.17.12. unique_campaigns_ids(public_id): int[]
8.20.17.13. orders_total
8.20.17.14. unique_orders_ids(public_id):
8.21. address
8.21.1. country
8.21.1.1. type: text
8.21.2. city
8.21.2.1. type: text
8.21.3. street
8.21.3.1. type: text
8.21.4. postal_code
8.21.4.1. type: text
9. creator_request(specific)
9.1. id
9.2. order_id
9.3. campaign_id
9.4. creator_id
9.5. status
9.5.1. values:
9.5.1.1. pending
9.5.1.2. rejected
9.5.1.3. accepted
9.5.1.4. expired
9.5.1.5. cancled
9.6. expiration_date
9.7. task_reward
9.7.1. amount(creator_share_cap)
9.7.2. currency
9.8. message
9.9. created_at
9.10. updated_at
9.11. additional_instructions (moves to task if accepted)
9.12. cancelation_reason
10. order_bid
10.1. id
10.2. order_id
10.3. creator_id
10.4. proposed_creator_fee: number
10.5. status
10.5.1. values
10.5.1.1. pending
10.5.1.2. accepted
10.5.1.3. rejected
10.5.1.4. cancel
10.6. submitted_at
10.7. example_assets
10.7.1. uuid[]
10.8. message
10.9. updated_at
10.10. cancelation_reason
11. task
11.1. id
11.2. order_id
11.3. campaign_id
11.4. creator_id
11.5. origin
11.5.1. values
11.5.1.1. request
11.5.1.2. bid
11.5.1.3. manual
11.6. status
11.6.1. awaiting_delivery
11.6.2. active (awaiting submission or re-submission)
11.6.3. asset_submitted
11.6.4. completed
11.6.5. failed
11.6.6. cancled
11.7. delivered_asstes: uuid[]
11.8. final_asset_id
11.9. product_info
11.9.1. name
11.9.1.1. type: text
11.9.1.2. required
11.9.2. descriprion
11.9.2.1. required
11.9.2.2. type: text
11.9.3. image_url
11.9.3.1. type: text
11.9.3.2. required
11.9.4. instructions
11.9.4.1. type: text
11.10. revision_count
11.11. additional_instructions
11.12. cancled_by
11.13. cancelation_reason
11.14. created_at
11.15. updated_at
11.16. timeline
11.16.1. object[]
11.16.1.1. timestamp
11.16.1.2. type
11.16.1.3. label
11.16.1.4. metadata
11.16.2. all events
11.16.2.1. request_accepted or bid_accepted
11.16.2.1.1. meta:
11.16.2.2. task_created
11.16.2.2.1. meta:
11.16.2.3. asset_uploaded
11.16.2.3.1. meta:
11.16.2.4. revision_requested
11.16.2.4.1. meta:
11.16.2.5. asset_updated
11.16.2.5.1. meta:
11.16.2.6. task success
11.16.2.6.1. meta:
11.16.2.7. task fail
11.16.2.7.1. meta:
11.16.2.8. task cancled
11.16.2.8.1. meta:
11.17. earnings: uuid[]
11.18. agreed_creator_fee
12. notification
12.1. id
12.2. user_id
12.3. type
12.3.1. TBA
12.4. title
12.5. message
12.6. data
12.7. status
12.7.1. unread
12.7.2. read
12.7.3. archived
12.8. priority
12.8.1. low
12.8.2. normal
12.8.3. high