Organization API: Org Staff Ops

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/staff/ops-summary

The numbers on the console's badges and the desk, for one audience view.

These count the whole brand and are the same for every member: open_tickets, pending_refunds, unpaid_invoices, unpaid_invoices_24h, pending_services, orders_24h, customers, community_open, chat_reports_open, sla_breached, signups_24h, dunning_failing, servers_attention, deliveries_attention (game network purchases whose delivery failed or that the network has not confirmed within 10 minutes) and audience_counts (paid and free totals, whatever the view). They are normally under a minute old, and the first request after a quiet spell can show numbers a few minutes old.

assigned_to_me and unread_alerts are for the member who asks and are always current.

GET /api/v1/orgs/{org_slug}/staff/orders

The brand's orders, paying customers first and newest first. Every filter is applied before the page is cut, so limit and offset walk exactly the orders that match. status_filter takes the words of its description, so a column title on the orders board lists exactly the orders in that column; plan, product and product_id narrow to one plan, kind of product or product, and created_after and created_before to the days the orders were placed. channel, first_channel, source, medium, campaign, device, heard_about and coupon_campaign keep the orders whose attribution record holds exactly that word (the Acquisition report's rows open the orders behind them this way). An order with no attribution record matches none of them, and a channel or first_channel that is not a channel key answers 422 with the keys that are.

GET /api/v1/orgs/{org_slug}/staff/orders/stats

One count per order status for the tiles above the list, under the audience the request carries. cancelled is spelled as the status value is (the way the invoice stats spell theirs); stuck folds pending, provisioning and failed orders that are paid for (or were never invoiced), from the clause the stuck list filters with.

The counts cover the whole brand. They are normally under a minute old, and the first request after a quiet spell can show numbers a few minutes old. The order list is always current, so a tile can trail a new order that the list already shows.

GET /api/v1/orgs/{org_slug}/staff/orders/{service_id}

One order: the order row, its customer, its invoices and its server.

attribution is where the buyer came from, or null for an order the storefront did not place (a staff order, a renewal) or one placed before attribution was recorded. It holds the first and last touch (each with its channel as {key, label}, the ad network and the UTM fields, or null when no visit was seen), the click_ids with their ad network, the buyer's heard_about answer, the coupon and its campaign, the affiliate_code, device_type, country_code, the consent the buyer had, whether the buyer was a new customer (is_new_customer) and the order free (is_free), and which identifiers we hold (identifiers). address.state is kept or truncated and address.network its network: the whole address is never sent. order.channel is the last touch's channel.

GET /api/v1/orgs/{org_slug}/staff/refund-requests

The refund requests, oldest first, so the longest wait is decided first.

pending is the size of the whole queue still to decide, whatever the status and search, which is what the consoles badge. With with_total=true the answer adds total (the requests the status and search match, counted from the same clause as the page), limit, offset and counts (all and each status, for the same search). Without it the answer keeps its older shape: status, pending, items and can_decide.

GET /api/v1/orgs/{org_slug}/staff/refund-requests/{request_id}

POST /api/v1/orgs/{org_slug}/staff/refund-requests/{request_id}/approve

application/json (required)

POST /api/v1/orgs/{org_slug}/staff/refund-requests/{request_id}/reject

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/search

Search accounts, invoices, orders, servers, tickets and coupons from one box.

Results are always current. The answer lists up to 20 accounts, 10 invoices, 10 orders, 10 servers, 10 tickets and 6 coupons.

Accounts, invoices and orders list paying ones first and the newest first within each group. The search reads the newest 300 paying matches and the newest 300 others of each kind (for invoices, the highest numbers), so a paying match is listed however many newer matches do not pay. A very broad needle lists the newest matches, not every match. Under the paid or free audience only that group is read, so the list is never empty while matches of that audience exist. Tickets are listed newest activity first, inside the audience.

Accounts whose address or handle starts with the needle are read first, and when twenty or more start with it the other fields are not searched. A word with an @ is matched against addresses only. A server is found by the start of its UUID (8 characters or more). A needle that is a whole UUID also finds every service whose record names it. Coupons need Tier 3 support or above.