API reference

Dashboard API

The endpoints the app itself calls. They take an API key as well as the app's session. Paths name the brand by its slug (/organizations/{org}/...), and a key reaches only its own brand. These are less settled than the public API; prefer the public API where it covers what you need.

/api/v1 (132)

  • GET/api/v1/affiliate_salesAttributed sales with creator, campaign and amounts
  • PATCH/api/v1/affiliate_sales/{id}Change a sale's status or commission (commission in cents)
  • GET/api/v1/affiliate_store_creatorsCreators in store campaigns with what they earned, paid and owed
  • GET/api/v1/affiliate_store_creators/summaryOwed and paid totals over the store creators filter
  • GET/api/v1/api_keysThe brand's API keys (shown masked)
  • POST/api/v1/api_keysCreate an API key; the key is in this answer only
  • DELETE/api/v1/api_keys/{id}Revoke an API key
  • GET/api/v1/api_usage/api_keysAPI calls per key
  • GET/api/v1/api_usage/endpointsAPI calls per endpoint
  • GET/api/v1/api_usage/requestsThe last calls made with the brand's keys
  • GET/api/v1/api_usage/summaryAPI calls in a window against the window before
  • GET/api/v1/api_usage/timeseriesAPI calls per day by status class
  • GET/api/v1/automationsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/automations/templatesShape onlyRecorded shape; no data source here yet
  • GET/api/v1/billing_planShape onlyRecorded shape; no data source here yet
  • GET/api/v1/campaign_affiliatesCreators in a campaign, as the campaign's creators tab lists them
  • GET/api/v1/campaign_affiliates/{id}/heavy_dataShape onlyRecorded shape; no data source here yet
  • GET/api/v1/campaign_possible_duplicatesShape onlyRecorded shape; no data source here yet
  • GET/api/v1/campaigns/{id}One campaign with every setting
  • PATCH/api/v1/campaigns/{id}Change a campaign's settings
  • GET/api/v1/campaigns/{id}/campaign_alertsWhat the brand is told about for a campaign
  • POST/api/v1/campaigns/{id}/duplicateCopy a campaign as a draft
  • POST/api/v1/campaigns/{id}/pinPin or unpin a campaign (body pinned: true|false, default true)
  • GET/api/v1/campaigns/{id}/program_overviewA campaign's totals: creators, sales, commission, content
  • POST/api/v1/campaigns/{id}/statusActivate, pause, end, archive or cancel a campaign
  • PUT/api/v1/campaigns/{id}/tiersReplace a campaign's tiers of one kind (body: kind, tiers[])
  • GET/api/v1/campaigns/contract_heavy_dataShape onlyRecorded shape; no data source here yet
  • GET/api/v1/campaigns/contract_usersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/campaigns/contractsCampaigns of type contract
  • GET/api/v1/campaigns/retainersCampaigns of type retainer
  • GET/api/v1/campaigns/tier_participantsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/chat_threads/chat_profileHow the brand appears in messages
  • GET/api/v1/chat_threads/unread_countUnread messages and threads
  • GET/api/v1/content_submission_tagsThe brand's submission tags
  • GET/api/v1/content_submissionsContent submissions with their active version
  • GET/api/v1/content_submissions/{id}One submission (lookup_type=version reads the id as a version id)
  • GET/api/v1/content_submissions/{id}/download_url/{version_id}Where to download a version's original file
  • GET/api/v1/content_submissions/{id}/download/{version_id}The original file of a version
  • GET/api/v1/content_submissions/{id}/version_historyEvery version of a submission
  • GET/api/v1/content_submissions/{id}/versions/{id}/{slug}Shape onlyRecorded shape; no data source here yet
  • GET/api/v1/content_submissions/{id}/versions/{version_id}/commentsThe review thread on a version
  • GET/api/v1/content_submissions/filter_optionsCampaigns, creators and dates submissions can be filtered by
  • GET/api/v1/content_submissions/pickerApproved submissions for building ads (id is the version id)
  • GET/api/v1/content_submissions/review_filter_optionsFilters for the review queue
  • GET/api/v1/content_submissions/review_queueSubmissions to review, grouped by campaign, with tallies and review deadlines
  • GET/api/v1/content_submissions/review_settingsThe brand's review settings
  • GET/api/v1/conversationsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/conversations/{id}/messagesShape onlyRecorded shape; no data source here yet
  • GET/api/v1/creator_academyShape onlyRecorded shape; no data source here yet
  • GET/api/v1/creator_custom_columnsColumns the brand added to its creator database
  • POST/api/v1/creator_custom_columnsCreate a CustomColumn
  • PATCH/api/v1/creator_custom_columns/{id}Change a CustomColumn
  • DELETE/api/v1/creator_custom_columns/{id}Delete a CustomColumn
  • GET/api/v1/creator_program_applicationsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/creator_tool_sponsorshipsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/crm_viewsSaved views of a table
  • POST/api/v1/crm_viewsCreate a CrmView
  • PATCH/api/v1/crm_views/{id}Change a CrmView
  • DELETE/api/v1/crm_views/{id}Delete a CrmView
  • GET/api/v1/email_events/indexShape onlyRecorded shape; no data source here yet
  • GET/api/v1/facebook/branded_content_ads_permissionWhether the brand's connected Instagram may run branded-content ads
  • GET/api/v1/invitations/{id}Shape onlyRecorded shape; no data source here yet
  • GET/api/v1/klaviyo_credentialShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organization_affiliate_tagsThe brand's creator tags
  • POST/api/v1/organization_affiliate_tagsCreate a AffiliateTag
  • PATCH/api/v1/organization_affiliate_tags/{id}Change a AffiliateTag
  • DELETE/api/v1/organization_affiliate_tags/{id}Delete a AffiliateTag
  • GET/api/v1/organizations/{org}The brand's organization record
  • PATCH/api/v1/organizations/{org}Change the brand's page details (logo, banner, description, links, support contacts)
  • GET/api/v1/organizations/{org}/{token}Shape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/affiliate_leaderboardShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/ambassador_sales_filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/billing_accessShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/campaign_affiliates_searchFind a creator in the brand's campaigns
  • GET/api/v1/organizations/{org}/creatorOne creator: profile, social accounts, campaigns and totals
  • GET/api/v1/organizations/{org}/creator_payout_breakdownWhat a payout pays for: posts, sales and deliverables
  • GET/api/v1/organizations/{org}/discord_engagement/serversShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/discount_code_rulesShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/email_settingsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/galleriesShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/growi_importImports from Growi and where each stands
  • POST/api/v1/organizations/{org}/growi_importCopy the brand's program from Growi with its Growi API key (body api_key)
  • GET/api/v1/organizations/{org}/index_tracking_eventsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/line_graphsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/meta_partnership_ad_requestsCreators who were asked for partnership-ad permission
  • GET/api/v1/organizations/{org}/meta_partnership_ad_requests/creator_whitelistingShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/meta_partnership_ad_requests/creatorsCreators with their Instagram accounts and partnership-ad status
  • GET/api/v1/organizations/{org}/orders_filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/productsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/query_from_sales_snapshotsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/shopify_collectionsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/shopify_link_settingsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/shopify_order_logsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/sms_blasts_campaignsCampaigns a text broadcast can go to, with how many creators each has
  • GET/api/v1/organizations/{org}/sms_messagesText broadcasts
  • GET/api/v1/organizations/{org}/stats_filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/stripe_accountShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/tik_tok_shop_creator_filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/tik_tok_shop_product_filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/user_contents_creatorsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/validateShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/validate_customerShape onlyRecorded shape; no data source here yet
  • GET/api/v1/organizations/{org}/webhooksWhere the brand's webhook events go
  • POST/api/v1/organizations/{org}/webhooksAdd a webhook URL; the signing secret is in this answer only
  • PATCH/api/v1/organizations/{org}/webhooks/{id}Change a webhook's URL, events, label or switch it on or off
  • DELETE/api/v1/organizations/{org}/webhooks/{id}Remove a webhook URL
  • GET/api/v1/organizations/{org}/webhooks/{id}/deliveriesRecent deliveries to a webhook
  • POST/api/v1/organizations/{org}/webhooks/{id}/testSend a test event to a webhook now
  • GET/api/v1/presigned_upload_url/video_statusShape onlyRecorded shape; no data source here yet
  • GET/api/v1/promo_modals/{slug}Shape onlyRecorded shape; no data source here yet
  • GET/api/v1/tik_tok_ads/accountsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/triple_whale_credentialShape onlyRecorded shape; no data source here yet
  • GET/api/v1/two_factorShape onlyRecorded shape; no data source here yet
  • GET/api/v1/usersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/{id}Shape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/app_download_linkShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/brand_referralsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/content_activityShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/creator_discount_codesShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/creator_homeShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/free_sample_applicationsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/line_graphs_mediaShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/marketplace_accessShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/meta_ad_code_requestsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/notificationsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/shopify_giftsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/spark_code_requestsShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/stats_filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/stripe_accountShape onlyRecorded shape; no data source here yet
  • GET/api/v1/users/table_optionsThe signed-in person's column settings for a table
  • PUT/api/v1/users/table_optionsSave the signed-in person's column settings for a table
  • GET/api/v1/users/user_contentsShape onlyRecorded shape; no data source here yet

/api/v2 (117)

  • GET/api/v2/organizations/{org}/{id}/filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/posting_countsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/seriesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/spikesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/summaryShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/top_campaignsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/top_creatorsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/{id}/top_postsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/ambassador_program_statsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/ambassador_programsAmbassador programs
  • GET/api/v2/organizations/{org}/assistant_conversationsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/audit_logsWho changed what in the brand
  • GET/api/v2/organizations/{org}/brand_detailsShape onlyRecorded shape; no data source here yet
  • POST/api/v2/organizations/{org}/campaigns/{campaign_id}/hub/sectionsAdd a hub section
  • PATCH/api/v2/organizations/{org}/campaigns/{campaign_id}/hub/sections/{id}Change a hub section
  • DELETE/api/v2/organizations/{org}/campaigns/{campaign_id}/hub/sections/{id}Remove a hub section
  • GET/api/v2/organizations/{org}/campaigns/{id}/assetsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/coursesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/field_definitionsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/forumA campaign hub's forum categories and threads
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/moderation/settingsA campaign hub's moderation rules
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/resourcesFiles and links in a campaign hub
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/sectionsA campaign hub's sections (the brand's until the campaign overrides them)
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/settingsA campaign hub's settings, each marked inherited or its own
  • PUT/api/v2/organizations/{org}/campaigns/{id}/hub/settingsOverride hub settings for one campaign (null clears an override)
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/taxonomies/feed_category/termsFeed categories for a campaign hub
  • GET/api/v2/organizations/{org}/campaigns/{id}/hub/video_reviews/settingsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/campaigns/{id}/signup_page_designA campaign's sign-up page design, each field marked inherited or its own
  • PUT/api/v2/organizations/{org}/campaigns/{id}/signup_page_designOverride the sign-up page design for one campaign
  • GET/api/v2/organizations/{org}/chat_threadsMessage threads with creators
  • GET/api/v2/organizations/{org}/chat_threads/{id}/messagesMessages in a thread
  • POST/api/v2/organizations/{org}/chat_threads/{id}/messagesQueue a message in a thread (or save a draft, or add a team note)
  • GET/api/v2/organizations/{org}/chat_threads/unread_countUnread messages and unassigned threads
  • GET/api/v2/organizations/{org}/collectionsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/contract_templatesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_activity_logsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_campaign_questionsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_discount_codesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_email_templateOne creator email: the brand's version and the default
  • PUT/api/v2/organizations/{org}/creator_email_templateSave the brand's version of a creator email
  • GET/api/v2/organizations/{org}/creator_email_templatesEmails creators get, and the brand's own versions
  • GET/api/v2/organizations/{org}/creator_free_sample_applicationsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_overviewA creator's campaigns and contracts with totals
  • GET/api/v2/organizations/{org}/creator_overview_heavy_dataShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_posts_progressShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_referralsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/creator_social_insightsShape onlyRecorded shape; no data source here yet
  • POST/api/v2/organizations/{org}/creatorsAdd a creator or a prospect to the database
  • GET/api/v2/organizations/{org}/creators_databaseThe brand's creator database
  • PATCH/api/v2/organizations/{org}/creators_database/{id}Change a creator record: stage, owner, rating, note, tags, custom values (id is the record id)
  • POST/api/v2/organizations/{org}/creators_database/{id}/recordMake sure a creator in a campaign has a database record (id is the creator id)
  • GET/api/v2/organizations/{org}/discover_creatorsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/home_onboardingWhich setup steps the brand has done
  • GET/api/v2/organizations/{org}/home_stats/{id}Shape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/home_stats/top_creators_by_gmvShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/home_v2/breakout_postsPosts gaining views far faster than their own pace the week before
  • GET/api/v2/organizations/{org}/home_v2/cohort_retentionCreators by the month of their first post, and how many post in each month after
  • GET/api/v2/organizations/{org}/home_v2/creator_retentionNew, retained, returning and churned creators per week or month
  • GET/api/v2/organizations/{org}/home_v2/filtersCampaigns, platforms and tags the home page can filter by
  • GET/api/v2/organizations/{org}/home_v2/rising_postsPosts from the last 72 hours ahead of the creator's other posts at the same age
  • GET/api/v2/organizations/{org}/home_v2/seriesDaily views and engagement
  • GET/api/v2/organizations/{org}/home_v2/spikesDays well above the trailing week
  • GET/api/v2/organizations/{org}/home_v2/summaryContent totals against the previous period
  • GET/api/v2/organizations/{org}/home_v2/top_accountsSocial accounts ranked by a content metric
  • GET/api/v2/organizations/{org}/home_v2/top_campaignsCampaigns ranked by a content metric
  • GET/api/v2/organizations/{org}/home_v2/top_creatorsCreators ranked by a content metric
  • GET/api/v2/organizations/{org}/home_v2/top_postsPosts ranked by a content metric
  • GET/api/v2/organizations/{org}/hub/foldersLibrary folders
  • GET/api/v2/organizations/{org}/hub/forum/categoriesForum categories
  • GET/api/v2/organizations/{org}/hub/moderation/auditShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/hub/moderation/countsHow many hub items wait for a moderator
  • GET/api/v2/organizations/{org}/hub/moderation/itemsHub items waiting for a moderator
  • GET/api/v2/organizations/{org}/hub/registryShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/hub/rulesHub rules
  • GET/api/v2/organizations/{org}/hub/sectionsThe brand hub's sections
  • POST/api/v2/organizations/{org}/hub/sectionsAdd a hub section
  • PATCH/api/v2/organizations/{org}/hub/sections/{id}Change a hub section
  • DELETE/api/v2/organizations/{org}/hub/sections/{id}Remove a hub section
  • GET/api/v2/organizations/{org}/hub/settingsThe brand hub's appearance and switches
  • PUT/api/v2/organizations/{org}/hub/settingsSave the brand hub's settings
  • GET/api/v2/organizations/{org}/hub/taxonomiesHub taxonomies with their terms
  • POST/api/v2/organizations/{org}/hub/taxonomies/{kind}/termsAdd a term to a hub taxonomy
  • GET/api/v2/organizations/{org}/hub/templatesSaved hub templates
  • GET/api/v2/organizations/{org}/hub/templates/{id}Shape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/instagram/accountsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/instagram/conversationsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/instagram/conversations/{id}/messagesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/instagram/conversations/unread_countShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/invoices/{slug}Shape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/invoices/openInvoices waiting for payment
  • GET/api/v2/organizations/{org}/meta_ad_accountsConnected Meta ad accounts
  • GET/api/v2/organizations/{org}/meta_adsMeta ads grouped by campaign, with ad sets and stats
  • GET/api/v2/organizations/{org}/meta_ads/copy_templatesSaved ad copy
  • GET/api/v2/organizations/{org}/meta_ads/default_ctaThe default call to action for built ads
  • GET/api/v2/organizations/{org}/meta_ads/namingHow built ads are named
  • GET/api/v2/organizations/{org}/meta_ads/saved_linksLinks saved for ads
  • GET/api/v2/organizations/{org}/meta_ads/utm_paramsUTM parameters added to ad links
  • GET/api/v2/organizations/{org}/meta_creatives/filtersShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/meta_creatives/overviewShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/meta_creatives/performanceShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/meta_creatives/performance/filter_optionsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/meta_creatives/timeseriesShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/organization_activity_logsWhat happened in the brand's program
  • GET/api/v2/organizations/{org}/sample_programsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/shopify_free_sample_applicationsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/shopify_giftsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/signup_page_designThe brand's sign-up page design
  • PUT/api/v2/organizations/{org}/signup_page_designSave the brand's sign-up page design
  • GET/api/v2/organizations/{org}/social_account_campaign_applicationsShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/store_campaignsCampaigns attributed through a store
  • GET/api/v2/organizations/{org}/table_viewsSaved views of a table
  • POST/api/v2/organizations/{org}/table_viewsCreate a TableView
  • PATCH/api/v2/organizations/{org}/table_views/{id}Change a TableView
  • DELETE/api/v2/organizations/{org}/table_views/{id}Delete a TableView
  • GET/api/v2/organizations/{org}/tik_tok_shop_videosShape onlyRecorded shape; no data source here yet
  • GET/api/v2/organizations/{org}/transaction_detailsOne transaction with its invoice
  • GET/api/v2/organizations/{org}/transactionsThe brand's ledger with sums over the window

/api/v3 (58)

  • GET/api/v3/campaignsCampaigns with their settings and totals
  • POST/api/v3/campaignsCreate a campaign (body: campaign settings by name)
  • GET/api/v3/campaigns/{id}/live_statsTotals for a running campaign
  • GET/api/v3/organizations/{org}The brand's organization record
  • GET/api/v3/organizations/{org}/ambassador_programsAmbassador programs
  • GET/api/v3/organizations/{org}/automationsThe brand's workflows
  • GET/api/v3/organizations/{org}/balancesThe brand's available and pending balance
  • GET/api/v3/organizations/{org}/brand_workflow_input_requestsDecisions workflows are waiting on
  • POST/api/v3/organizations/{org}/brand_workflow_input_requests/{id}/answerAnswer what a workflow is waiting on
  • GET/api/v3/organizations/{org}/brand_workflowsThe brand's workflows
  • GET/api/v3/organizations/{org}/campaignsThe brand's campaigns for pickers
  • GET/api/v3/organizations/{org}/campaigns_and_contractsCampaigns and contracts for pickers
  • GET/api/v3/organizations/{org}/collectionsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/connected_accountsAccounts the brand connected (mailbox, Facebook, ad accounts ...)
  • GET/api/v3/organizations/{org}/creator_payoutsWhat the brand owes or paid each creator
  • POST/api/v3/organizations/{org}/creator_payoutsAdd a payout to a creator (amount in dollars)
  • POST/api/v3/organizations/{org}/creator_payouts/{id}/approveApprove a payout (queues it for the payout provider)
  • POST/api/v3/organizations/{org}/creator_payouts/{id}/cancelCancel a due payout
  • POST/api/v3/organizations/{org}/creator_payouts/{id}/mark_paid_externallyRecord a payout paid outside the platform
  • GET/api/v3/organizations/{org}/creator_payouts/totalsPaid and owed totals over the same filters
  • GET/api/v3/organizations/{org}/creator_payouts/updates_pauseWhether payout recalculation is paused
  • POST/api/v3/organizations/{org}/creator_payouts/updates_pausePause payout recalculation for a while (body duration_minutes; 0 resumes)
  • GET/api/v3/organizations/{org}/current_user_notification_preferencesThe signed-in person's notification choices
  • PUT/api/v3/organizations/{org}/current_user_notification_preferencesSave the signed-in person's notification choices
  • GET/api/v3/organizations/{org}/customerShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/dashboard/salesSales and commission by channel against the previous period
  • GET/api/v3/organizations/{org}/discord_serversShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/email_verification_usage_invoicesShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/has_hidden_leads_campaignShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/inbox_itemsWhat is waiting on the brand, and what was dealt with
  • GET/api/v3/organizations/{org}/organization_invitationsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/organization_storefrontShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/organization_usersShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/shopify_ambassadors/insightsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/shopify_ambassadors/statsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/slackShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/sms_usage_invoicesShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/stagesCRM stages with how many creators are in each
  • POST/api/v3/organizations/{org}/stagesCreate a Stage
  • PATCH/api/v3/organizations/{org}/stages/{id}Change a Stage
  • DELETE/api/v3/organizations/{org}/stages/{id}Delete a Stage
  • GET/api/v3/organizations/{org}/tik_tok_shopShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/tik_tok_shop_partnerShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/tik_tok_shop_statsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/workflows/{slug}Shape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/workflows/{slug}/tik_tok_shop_dmsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/workflows/{slug}/tik_tok_shop_invitesShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/workflows/healthShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/workflows/health/tik_tok_shop_dmsShape onlyRecorded shape; no data source here yet
  • GET/api/v3/organizations/{org}/workflows/health/tik_tok_shop_invitesShape onlyRecorded shape; no data source here yet
  • GET/api/v3/users/meShape onlyRecorded shape; no data source here yet
  • GET/api/v3/users/me/intercom_jwtShape onlyRecorded shape; no data source here yet
  • GET/api/v3/workflowsWorkflows with counts by status
  • POST/api/v3/workflowsCreate a workflow (version 1 steps or a version 2 graph)
  • GET/api/v3/workflows/{id}One workflow
  • PATCH/api/v3/workflows/{id}Change a workflow, or start, pause or archive it
  • GET/api/v3/workflows/{id}/runsCreators going through a workflow
  • GET/api/v3/workflows/catalogWorkflow node types and condition fields

Shape only: answers 200 with the recorded keys and empty values until its area is filled in.