Another API description

Resources

Account::Invoices

Resource Description
GET /api/accounts/:account_id/invoices Lists all account invoices
GET /api/accounts/:account_id/invoices/:id.pdf Download account invoice
POST /api/accounts/:account_id/invoices Creates invoice

Account::OfflineCredits

Resource Description
POST /api/accounts/:account_id/offline_credits Creates an offline credit for given account

Account::OfflineServices

Resource Description
GET /api/accounts/:account_id/offline_services Lists Offline Services
POST /api/accounts/:account_id/offline_services Creates an offline payment for given account

Account::Transactions

Resource Description
GET /api/accounts/:account_id/transactions Lists account transactions

Accounts

Resource Description
PATCH /api/users/:user_id/accounts/:id/serpbook_key Add serpbook key
GET /api/users/:user_id/accounts/:id/serpbook_account_info
POST /api/users/:user_id/accounts/:id/invite_member Invite member to the account
PUT /api/users/:user_id/accounts/:id/member_role Modify member role in the account
GET /api/users/:user_id/accounts/:id/pending_member_invitations Lists pending member invitations
DELETE /api/users/:user_id/accounts/:id/delete_member_invitation Deletes pending member invitations
GET /api/users/:user_id/accounts/:id/members Lists account members
DELETE /api/users/:user_id/accounts/:id/delete_member Remove account member
GET /api/users/accounts/all Lists all accounts
GET /api/users/:user_id/accounts Lists current_user's accounts
GET /api/users/:user_id/accounts/registered Lists given user's registered accounts.
GET /api/users/:user_id/accounts/:id Represents account's detail
POST /api/users/:user_id/accounts Creates User Account
PUT /api/users/:user_id/accounts/:id Updates User Account
DELETE /api/users/:user_id/accounts/:id Destroys User account

Activities

Resource Description
GET /api/activities/completed_tutorials Returns completed tutorials count though given date range

Applications

Resource Description
GET /api/oauth/applications Lists current_user's open auth applications
GET /api/oauth/applications/:id Represents appliaction's detail
POST /api/oauth/applications Creates Oauth Application
PUT /api/oauth/applications/:id Updates Oauth Application
DELETE /api/oauth/applications/:id Destroys Oauth Application

Assets

Resource Description
GET /api/assets Fetches Assets

Authorizations

Resource Description
GET /api/oauth/authorize/new Application authorization intermediate url.

Checkouts

Resource Description
POST /api/accounts/:account_id/checkouts Creates payment session
POST /api/accounts/:account_id/checkouts/execute Executes Paypal Payment

Cint controller

Resource Description
GET /api/cint/analytics/survey_attemp/:user_id/:survey_id Notify survey start.

Connections

Resource Description
GET /api/project2s/:project_id/connections Lists project's connections.
DELETE /api/project2s/:project_id/connections/:id Removes connection.
POST /api/project2s/:project_id/connections/:id Re triggers project's hooks.

Projects/ContentOrders

Resource Description
GET /api/project2s/:project_id/content_orders Lists ContentOrders for Project.
POST /api/content_orders/upload_for_preview
GET /api/project2s/:project_id/content_orders/:id/for_editor Retrieves ContentOrder for Editor.
GET /api/content_orders/sample_output Returns sample output for zapier
GET /api/content_orders/task_feed Content Orders for task feed.
POST /api/content_orders/:id/block_user Blocks user for specific roles
GET /api/content_orders/:id/activities Get content order activity history
POST /api/content_orders/multiple_order_action Performs an action on multiple content orders.
GET /api/content_orders/sample_content Returns loved by publishers sample content
GET /api/project2s/:project_id/content_orders/:id Retrieves ContentOrder.
GET /api/project2s/:project_id/content_orders/:id/content_cache Retrieves Content Cache.
POST /api/project2s/:project_id/content_orders Creates ContentOrder for Project.
PUT /api/project2s/:project_id/content_orders/:id Updates ContentOrder for Project.
POST /api/project2s/:project_id/content_orders/:id/take_over Takeover or refresh taking over.
POST /api/project2s/:project_id/content_orders/:id/start Start Content Order
POST /api/project2s/:project_id/content_orders/:id/send_forward Sends the order forward in workflow.
POST /api/project2s/:project_id/content_orders/:id/send_back Sends the order forward in workflow.
POST /api/project2s/:project_id/content_orders/:id/drop Sends the order forward in workflow.
POST /api/project2s/:project_id/content_orders/:id/flag Sends the order forward in workflow.
POST /api/project2s/:project_id/content_orders/:id/pause Pauses the content order.
POST /api/project2s/:project_id/content_orders/:id/cancel Cancels the content order.
PATCH /api/project2s/:project_id/content_orders/:id/workflow_assign Assigns actor to a workflow task.
PATCH /api/project2s/:project_id/content_orders/:id/toggle_published Toggles between approved and published states
DELETE /api/project2s/:project_id/content_orders/:id Delete ContentOrder for Project

Content parts

Resource Description
PUT /api/content_orders/:content_order_id/content_parts/:id Updates content part.

Credit cards

Resource Description
GET /api/accounts/:account_id/credit_cards Lists account saved credit cards
POST /api/accounts/:account_id/credit_cards Creates saved credit card data
POST /api/accounts/:account_id/credit_cards/:id Updates credit card data
DELETE /api/accounts/:account_id/credit_cards/:id Destroys saved credit card
PATCH /api/accounts/:account_id/credit_cards/:id/activate Activates saved credit card
PATCH /api/accounts/:account_id/credit_cards/:id/deactivate Deactivates saved credit card
PATCH /api/accounts/:account_id/credit_cards/:id/mark_as_default Marks the card as default.

Currencies

Resource Description
GET /api/currencies Lists currencies
GET /api/currencies/convert_euro Lists currencies

Domains

Resource Description
GET /api/domains Lists domains.
GET /api/domains/:id Shows project domain.
PUT /api/domains/:id Update domain
POST /api/domains Creates new domain.
DELETE /api/domains/:id Delete domain
POST /api/domains/upload_from_tsv Uploads domain from TSV file.
GET /api/domains/assumptions
GET /api/domains/parse_meta
POST /api/domains/invite_account Invite member for share domain
GET /api/domains/shared_accounts List accounts of domain
DELETE /api/domains/delete_shared_account Remove shared account
GET /api/domains/analytics
GET /api/domains/projects Projects where the given domain is used
POST /api/domains/multiple_domain_action Performs an action on multiple domains.
GET /api/domains/domain_count
GET /api/domains/whois
GET /api/domains/serpbook
GET /api/domains/regions_and_languages
POST /api/domains/serpbook_actions
GET /api/domains/suggestion_keywords
POST /api/domains/change_owner Change domain owners
GET /api/domains/serpbook_tmp_to_real
POST /api/domains/save_scripts
GET /api/domains/plugin_list
POST /api/domains/plugin_remote_actions
GET /api/domains/listing
POST /api/domains/listing_action

Gads

Resource Description
GET /api/gads/accounts Get list of Google Ads accounts
POST /api/gads/add_account Add a new Google Ads account
POST /api/gads/authorize Authorize Google ads account
DELETE /api/gads/delete_account Delete Google Ads account
GET /api/gads/campaigns Get list of Google Ads campaigns
GET /api/gads/ad_groups Get list of Google Ads ad groups
GET /api/gads/selected_text_ad_items Get list of selected text ads
GET /api/gads/exp_text_ad_items Get list of expanded text ads
POST /api/gads/upload_exp_text_ad_orders Upload new expanded text ad orders
GET /api/gads/subscriptions Get list of subscriptions
GET /api/gads/goals Get list of goals
GET /api/gads/samples Get list of sample ads
POST /api/gads/order Google Ads order wizard

Goals

Resource Description
GET /api/goals Lists Goals
POST /api/goals Creates goal
PUT /api/goals/:id Updates goal

Google analytics

Resource Description
GET /api/google_analytics/credentials Get credentials of connected google analytics account
POST /api/google_analytics/connect Add a new Google Analytics account
POST /api/google_analytics/disconnect Disconnect google analytics account
GET /api/google_analytics/accounts Get all google analytics account
GET /api/google_analytics/properties Get properties of connected google analytics account
PATCH /api/google_analytics/update_google_analytics_ids Google analytics account, view and web property id
GET /api/google_analytics/connected_domains Get connected domains
GET /api/google_analytics/metric Google Analytics Metrics
GET /api/google_analytics/goals Google Analytics Goals

Intercom

Resource Description
GET /api/intercom/data Required data for front office

Invite urls

Resource Description
GET /api/project2s/:project_id/invite_urls Lists invitation link for the project
POST /api/project2s/:project_id/invite_urls Creates invitation link for the project
POST /api/project2s/:project_id/invite_urls/:id/email Sends invitation e-mail

Invitees

Resource Description
POST /api/project2s/:project_id/invitees Creates invitation for the project

Invoice profiles

Resource Description
PUT /api/invoice_profiles/:user_id Updates a user profile.
GET /api/invoice_profiles/:user_id Returns invoice profile.
GET /api/invoice_profiles/required_fields Returns required fields.

Invoices

Resource Description
GET /api/invoices/summary Returns invoice summaries

Notifications

Resource Description
GET /api/notifications Notifications of current user.
GET /notifications/:id Notification detail
DELETE /notifications/:id Deletes the notification
GET /notifications/unread-counts Unread notification count
PATCH /notifications/read-all Marks as read all unread notifications

Offline payments

Resource Description
POST /api/users/:user_id/offline_payments Creates an offline payment record.
GET /api/users/:id/approved_balance
POST /api/users/:user_id/offline_payments/reward_points_action Add and Deduct reward points

Offline services

Resource Description
POST /api/users/:user_id/offline_services Creates an offline service.

Participants

Resource Description
GET /api/project2s/:project_id/participants Lists project participants
POST /api/project2s/:project_id/participants Creates project participant
PUT /api/project2s/:project_id/participants/:id Updates project participant
DELETE /api/project2s/:project_id/participants/:id Deletes project participant
PATCH /api/project2s/:project_id/participants/:id/pause Pauses project participant.

Passwords

Resource Description
POST /api/users/passwords Creates new reset password token
POST /api/users/passwords/renew Updates user password with reset password token

Payment intents

Resource Description
POST /api/accounts/:account_id/payment_intents Creates A payment intent
POST /api/accounts/:account_id/payment_intents/validate Validates Payment Intent

Payment methods

Resource Description
GET /api/users/:user_id/payment_methods List user payment methods
GET /api/users/:user_id/payment_methods/:id Returns Payment Method
POST /api/users/:user_id/payment_methods Creates Payment Method
PUT /api/users/:user_id/payment_methods/:id Returns Payment Method
DELETE /api/users/:user_id/payment_methods/:id Delete Payment Method
GET /api/users/:user_id/payment_methods/required_fields Returns Required Fields

Payments

Resource Description
GET /api/payments Lists Payments
POST /api/payments/:id/reprocess Reprocess the payment if it is failed
POST /api/payments/mass_pay This does mass payment
POST /api/payments/mass_cancel This does mass cancel

Pdx2

Resource Description
POST /api/pdx/op PDX Endpoint
POST /api/pdx/tickets PDX Tickets Processing Endpoint
POST /api/pdx/notify PDX Notification Processing Endpoint

Pending tasks

Resource Description
GET /api/project2s/:project_id/pending_tasks Shows project pending task.

Preferences

Resource Description
GET /api/users/:user_id/preferences Lists user preferences
PUT /api/users/:user_id/preferences/:id Update user preference

Project2s

Resource Description
GET /api/project2s Lists projects for the session user.
GET /api/project2s/:id Shows project details.
POST /api/project2s Creates new project.
DELETE /api/project2s/:id Delete project
POST /api/project2s/:id/statistics Project statistics
GET /api/project2s/:id/export Exports project's content orders in given format such as xml,json, csv or markdown
POST /api/project2s/:id/copy Copies Project2
PUT /api/project2s/:id Update Project
POST /api/project2s/confirm_upload_duplicates Confirming of upload duplicates
PUT /api/project2s/:id/upload_content_orders Upload Content Orders
POST /api/project2s/upload_content_text Upload Content Orders Text
PUT /api/project2s/upload_content_orders Upload Content Orders
POST /api/project2s/:id/block_user Blocks user for specific roles
POST /api/project2s/:id/unblock_user Unblocks user for specific roles or for all roles
GET /api/project2s/:id/blocked_users Returns blocked user list

Projects

Resource Description
GET /api/accounts/:account_id/projects Lists all accounts's projects

Quote forms

Resource Description
POST /api/quote_forms/translation_order Uploads files regarding translation

Receipts

Resource Description
GET /api/accounts/:account_id/receipt/:id Shows receipt details

Reports

Resource Description
GET /api/reports/zip_account_invoices Returns 202 status code

Rules

Resource Description
GET /api/rules Lists content rules.

Self invoices

Resource Description
DELETE /api/self_invoices/:id Delete self invoice
POST /api/self_invoices/mass_delete This does mass payment
POST /api/self_invoices/:id/pay Pays an invoice and returns Offline Payment
GET /api/self_invoices/summary Returns invoice summaries
GET /api/self_invoices/zip_summary Returns 202 status code
GET /api/users/:user_id/self_invoices List user invoices
POST /api/users/:user_id/self_invoices Creates Invoice
GET /api/users/:user_id/self_invoices/:id Returns invoice detail

Setup intents

Resource Description
POST /api/accounts/:account_id/setup_intents Creates SetupIntent for credit card

Stats

Resource Description
GET /api/stats/revenues Lists revenues
GET /api/stats/deposits Lists deposits
GET /api/stats/active_accounts Lists active accounts
GET /api/users/:user_id/stats Returns user stats

Template details

Resource Description
GET /api/project_templates/:project_template_id/details Returns project template's details.
POST /api/project_templates/:project_template_id/details/multi_persist Push multiple detail items for 1 template

Template items

Resource Description
GET /api/template_items Returns project template's items.

Templates

Resource Description
GET /api/project_templates
GET /api/project_templates/:id
POST /api/project_templates
PUT /api/project_templates/:id
GET /api/project_templates/:id/export
GET /api/project_templates/:id/empty_sheet
DELETE /api/project_templates/:id
GET /api/project_templates/assumptions
POST /api/project_templates/:id/my_templates
DELETE /api/project_templates/:id/my_templates
GET /api/project_templates/content_cache
POST /api/project_templates/upload_prices Upload Prices
GET /api/project_templates/prices Shows templates prices
POST /api/project_templates/upload Upload and create template.
GET /api/project_templates/instructions
POST /api/project_templates/save_instructions
POST /api/project_templates/validate_template
POST /api/project_templates/build_from_html
GET /api/project_templates/by_domain

Transactions

Resource Description
GET /api/users/:user_id/transactions

Users

Resource Description
GET /api/me Returns the details of current user.
GET /api/users Lists users.
GET /api/users/:id Shows the given user details.
PUT /api/users/:id Updates current user.
PATCH /api/users/:id/update_password Updates user password
PATCH /api/users/:id/accept_tnc Accepts Terms & Conditions
PATCH /api/users/:id/update_email Updates user e-mail. This requires current password of user.
POST /api/users/:id/send_confirmation_instructions Send confirmation instructions
POST /api/users/check_email Checks whether an e-mail exists or not
POST /api/users/check_username Checks whether a username exists or not
GET /api/users/approved_balances Download approved balances in given format
POST /api/users/upload_approved_balances Bulk upload for approved balances in Euro.
POST /api/users/confirm_account Confirms user account with confirmation token
GET /api/users/:id/authorized_applications List current users's authorized applications.
DELETE /api/users/:id/authorized_applications Revoke current users's authorized application.
GET /api/users/:id/scores Shows the given user's scores.
GET /api/users/:id/quality_score_graph Returns quality score time series to draw graph.
GET /api/users/:id/quality_score_details Returns quality score time series to draw graph.
GET /api/users/:id/statistics Shows the given user statistics.
GET /api/users/user_signup_statistics Returns new user count though given date range
GET /api/users/daily_active_users Returns daily active users in give range
GET /api/users/free_sample_statistics Get free sample statistics
GET /api/users/language_levels_statistics Get lang level stat on daily basis
PATCH /api/users/:id/update_reward_points Update reward points of user

Withdraw

Resource Description
POST /api/withdraw Hits for withdraw
GET /api/withdraw/transaction_fees Returns transaction fees
GET /api/withdraw/totals Returns pending / withdrawable / requested / hyper_wallet totals
POST /api/withdraw/transfer Transfer money from freelancer account to business account

Works

Resource Description
GET /api/users/:user_id/works Lists user works
GET /api/users/:user_id/works/:id/history Shows history of work.
GET /api/users/works/text_difference Calculates text difference.