Fours API Reference
The Fours API is Fours' public REST API: it lets your own systems manage the products, offers, entitlements, buyers, usage metering, co-sell opportunities, funding applications, partners and partner training you work with in the Fours console, read your revenue records, and query your analytics and save charts and dashboards from it.
Base URL: https://api.suger.cloud. Most endpoints are
scoped to an organization under /org/{orgId}/…, and request
and response bodies are JSON (application/json).
Revenue, analytics and partner relationship management (PRM) operations use
/ai/org/{orgId}/revenue/…,
/ai/org/{orgId}/analytics/… and
/ai/org/{orgId}/prm/… on the same API host.
Keep the /ai prefix when calling these endpoints.
Authentication
The API uses the OAuth 2.0 client-credentials flow. Create an
OAuth App to get a client ID and secret,
exchange them for a short-lived (1 hour) bearer token, then send it on every
request as Authorization: Bearer <token>.
curl -X POST 'https://api.suger.cloud/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=YOUR_CLIENT_ID' \
--data-urlencode 'client_secret=YOUR_CLIENT_SECRET' \
--data-urlencode 'resource=https://api.suger.cloud'
Revenue and analytics operations require a bearer token. PRM operations also accept a legacy
API key sent as Authorization: Key <api-key>.
See API Access for the full token exchange,
caching, rotation, and permissions.
Conventions
- Pagination: list endpoints commonly accept
limitandoffsetquery parameters. - Errors: the API uses standard HTTP status codes;
4xxand5xxresponses return a JSON body describing the problem. - Request bodies:
GETandDELETEoperations never take a body — pass every input as a path or query parameter.POST,PUTandPATCHoperations send JSON. - Versioning: see Versioning and compatibility
below — the resource API is unversioned, and
apiv2is an older name for the same host, not an API version. - Rate limits: authenticated endpoints are not rate limited per
request. Usage is bounded by your organization's
service quotas instead. A few endpoints, such as
analytics queries, answer
429while too many requests of the same kind are already running; retry after a short wait. - Idempotency: a few operations protect you from a duplicate on
retry, each in its own way:
-
POST /org/{orgId}/offeris de-duplicated for 60 seconds — a repeat call with an identical body from the same caller returns the original response rather than creating a second offer. -
POST /org/{orgId}/entitlement/{entitlementId}/usageRecordGroupde-duplicates on theidyou supply, for 15 days; reporting the sameidagain is rejected rather than billed twice. -
The PRM invitation endpoints refuse a second invitation to a recipient who
already has one pending, with
409and no second email.
-
Versioning and compatibility
Three different "versions" appear around this API, and only one of them describes the resource contract. This is the whole policy:
| What | Versioned? | What it means for you |
|---|---|---|
The resource API, https://api.suger.cloud | Unversioned and rolling | There is no version segment in the path and no version header. There is one live contract. This reference is built from the API's latest source rather than from the release running in production, so a new or changed operation can appear here, and a withdrawn one disappear, shortly before the live API changes. |
The older host name apiv2.suger.cloud | Not a version: the same host as api.suger.cloud | apiv2 is an older name for the same host and keeps working; it is not a version
of the resource API. Use api.suger.cloud to request a token and to call
https://api.suger.cloud — see API Access.
|
This OpenAPI document (info.version 1.0) | The document's own release number | It identifies the specification file, not the API. Do not branch client behavior on it. |
What counts as a breaking change. Removing an operation or a response field, renaming either, narrowing an accepted value, or making an optional request field required. Fours avoids these on the public surface; when an operation is renamed, merged into another or withdrawn, its documentation page is removed and the old URL redirects to the operation that replaces it, or to this reference when none does. Additive changes — a new operation, a new optional request field, a new field in a response, or a new value in an existing enumeration — can ship at any time, so parse responses leniently and ignore fields you do not recognize.
Every operation listed here is currently supported — the reference carries no deprecated operations. Operations that have been renamed, merged or withdrawn are removed from this reference, and their old documentation URLs redirect to the operation that replaces them, or here. If you need advance notice before an operation you depend on changes, contact support@suger.io.
Endpoint groups
Endpoints are organized into the following groups:
- API
- Analytics
- Auditing
- Buyer
- Contact
- Cosell
- Entitlement
- Funding
- Metering
- Notification
- Offer
- OfferSet
- Operation
- Organization
- Partner Relationship Management
- Product
- Report
- Revenue
- Support
- Training
All operations
Every operation has its own page at /api/<operation>/ — open one
below or from the sidebar — with its parameters, request body and responses, a runnable
request, and an example response. Each page also has a Markdown version at
/api/<operation>.md for agents and LLMs.
API
- List API Clients GET List all API clients in the given organization.
- Get API Client GET Get the API client by ID.
Analytics
- List the Analytics Datasets GET Lists the datasets the caller can query, each with its description, the names of its measures and segments…
- Get an Analytics Dataset GET Gets a dataset the caller can query: its fields, measures, segments and relationships, with their types and…
- Get the Analytics Query Grammar GET Gets the grammar of an analytics query, as types with a line for each part and each op, and worked example…
- Check an analytics query without running it POST Checks a query, and a chart config against the query's result when one is given, without reading any data.
- Run an Analytics Query POST Runs a query against the organization's published analytics data and returns its rows, with each column's…
- Get a saved analytics chart's data GET Runs a saved chart's query and returns its result, read with the caller's own permissions.
- Get a saved analytics dashboard's data GET Runs the query of each chart block of a dashboard under a viewer's state, read with the caller's own…
- Get One Chart Block's Data GET Runs one chart block's query under a viewer's state, as GetAnalyticsDashboardData does for every block: a…
- Get a Select Filter's Choices GET Lists a select filter's choices: its field's values among the rows the other filters leave and the charts it…
- Get the rows behind a chart block POST Lists a page of the records behind a chart block's numbers: its dataset's detail fields, newest first, under…
- List Saved Analytics Charts GET Lists the organization's saved charts, newest first, a page at a time.
- Save an Analytics Chart POST Saves a chart: a query, and the config that draws its result when one is given, both checked as…
- Get a Saved Analytics Chart GET Gets a saved chart: its title, description, version, query and chart config.
- Update a Saved Analytics Chart PUT Changes a chart's title, description, query or chart config, and moves it to its next version; an update that…
- Delete a Saved Analytics Chart DELETE Deletes a saved chart.
- List Saved Analytics Dashboards GET Lists the organization's dashboards, newest first, a page at a time, each with its document.
- Create an Analytics Dashboard POST Creates a dashboard from its document: its layout tree of blocks, the filters a viewer sets, and its…
- Check an Analytics Dashboard Document POST Checks a dashboard document as CreateAnalyticsDashboard would, without saving it: every problem at once, each…
- Get a Saved Analytics Dashboard GET Gets a dashboard's document with the live saved charts the caller may read, in reading order, and for each…
- Update an Analytics Dashboard PUT Replaces a dashboard's document with the one given, checked as CreateAnalyticsDashboard checks it, and moves…
- Delete an Analytics Dashboard DELETE Deletes a dashboard.
- Add a saved chart to an analytics dashboard POST Places a saved chart of the organization on a dashboard as a block of the full width, at `position` among the…
- Lay Out an Analytics Dashboard PUT Moves, sizes, renames and deletes a dashboard's blocks as its page's editor does, and moves the dashboard to…
Auditing
- Query Auditing Events GET Query auditing events with filtering, sorting, and pagination using CRUD query language.
Buyer
- List Buyers GET List buyers under the given organization with pagination and optional filters.
- Create Buyer POST create a new buyer for Stripe or Adyen under the given organization.
- Query Buyers GET Query buyers with filtering, sorting, and pagination using CRUD query language.
- Get Buyer GET get buyer by the given organization and buyer id.
- Update Buyer PATCH update buyer by the given organization and buyer id.
- List Buyer's Wallets GET list all wallets of a buyer.
- Create Credit Wallet POST create a new credit wallet for the buyer.
- Update Credit Wallet PATCH update startTime or expireTime of the wallet.
- Delete Buyer Wallet DELETE delete a wallet of the buyer, if it's a payment method, sync to payment provider too.
- Close Credit Wallet PATCH Close the given credit wallet, if it's a payment method, sync to payment provider too.
- Set Buyer Default Wallet PATCH set a payment method wallet as buyer's default wallet.
Contact
- List Contacts GET List all contacts under the given organization.
- Create Contact POST Create a contact under the given organization.
- Batch Create Contacts POST Create multiple contacts under the given organization.
- Query Contacts GET Query contacts with filtering, sorting, and pagination using the CRUD query language.
- Get Contact GET Get the Contact by the given contact ID.
- Update Contact PATCH Update the contact for the given organization and contact ID.
- Add Contact to Buyer POST add contact to buyer by the given organization, buyer id and contact id.
- Remove Contact from Buyer DELETE remove contact from buyer by the given organization, buyer id and contact id.
- Add Contact to Offer POST add contact to offer by the given organization, offer id and contact id.
- Remove Contact from Offer DELETE remove contact from offer by given organization, offer id and contact id.
- Update Contact Tags PATCH Update the tags for a contact.
Cosell
- List Co-Sell Leads GET List AWS Partner Central co-sell leads for the organization.
- Get a co-sell lead by ID GET Fetch full details of a single co-sell lead, including the invitation and (once accepted) the full lead…
- Accept a Co-Sell Lead Invitation POST Accept a PENDING AWS Partner Central lead invitation for this organization, which starts the outbound sync…
- Get Co-Sell Dashboard / Insights GET Retrieve co-sell analytics for the organization.
- Search AWS connected partners by name POST Search the org's connected AWS partners by name.
- Search Microsoft first-party products for an Azure co-sell GET Search Microsoft's own products (Azure, Microsoft 365, Dynamics and the rest of the first-party catalog) by…
- Invite a partner to collaborate on an Azure referral (Azure only) POST Send a collaboration invitation to another Microsoft partner on an existing Azure co-sell referral.
- Search third-party solutions for an Azure co-sell GET Search the solutions published by companies other than Microsoft in the Partner Center catalog, and return…
- List known partner contacts for a buyer company GET Look up partner-side contacts (AWS / AZURE / GCP partner reps) associated with a buyer company, identified by…
- List co-sell referrals (inbound + outbound) GET List co-sell referrals under the organization with pagination, filters, and sort.
- Create a Co-Sell Referral (Outbound) POST Create a new outbound co-sell referral to share a sales opportunity with a cloud partner (AWS / AZURE / GCP).
- Batch Create Co-Sell Referrals POST Create multiple co-sell referrals in one call.
- Preview co-sell referrals mapped from CRM records POST Read one or more CRM records (for example Salesforce Opportunities) and return what each would look like as a…
- Predict AWS Opportunity Quality Score POST Predict the AWS opportunity quality score (0-100) for a not-yet-submitted AWS co-sell opportunity draft.
- Dry-run validate a co-sell referral against partner schema POST Validate a mapped marketplace opportunity against the partner-specific schema (AWS ACE / Azure Partner Center…
- Get a co-sell referral by ID GET Fetch full details of a single co-sell referral, including partner-specific fields, current Fours unified…
- Update a co-sell referral (incl. status / stage transitions) PATCH Update fields of an existing co-sell referral.
- Propose an AWS referral update for a person to approve PUT Stage a proposed change to an AWS co-sell referral, or record an outcome that needs a person, without…
- Get a referral's AWS funding recommendation GET Ask AWS Partner Central which funding programs this co-sell referral qualifies for.
- Sync a single co-sell referral with the partner / CRM POST Trigger a one-way sync for a specific referral.
Entitlement
- List Entitlements GET List entitlements under the given organization with pagination and optional filters.
- Create Entitlement POST Create a new entitlement for the given buyer & offer.
- Query Entitlements GET Query entitlements with filtering, sorting, and pagination using CRUD query language.
- Get Entitlement GET Get the entitlement by ID.
- Add Entitlement Credit POST Add the credit amount to the given Entitlement.
- Apply Addon to Entitlement POST Apply one billing addon to the given Entitlement.
- Approve Entitlement POST Approve the given Entitlement.
- List Entitlement Cancellation Requests GET List entitlement cancellation requests with filtering, sorting, and pagination.
- Cancel Entitlement POST Cancel the active subscription.
- Withdraw Entitlement Cancellation Request POST Withdraw an entitlement cancellation request.
- Divide Entitlement Commit POST Divide the commit equally from the given entitlement into sub entitlement terms based on the given time…
- Update Entitlement Name PATCH Update the name of the given Entitlement.
- List Entitlement Terms GET List all Entitlement Terms of the given Entitlement.
- Get Entitlement Term GET Get the entitlement term by ID.
- Delete Entitlement Term DELETE Delete the entitlement term by the given entitlement ID and entitlement term ID.
- Update Entitlement Meta Info PATCH Update the meta info of the given entitlement.
- Get Entitlement Agreement PDF GET Returns a presigned S3 URL for the agreement PDF of the given AWS entitlement.
- Update Entitlement Price Model PATCH Update the price model of the given entitlement, such as recurring commits, billable dimensions.
- Adjust the renewal uplift for an entitlement POST Reprice the pending renewal offer to a seller-chosen in-range uplift (AWS).
- Get the draft renewal offer for an entitlement GET Return the pending draft renewal offer as a WorkloadOffer so the seller can resume editing it (AWS). 404 when…
- Opt out of auto-renewal for an entitlement POST Expire the pending renewal offer so the agreement does not auto-renew (AWS).
- Schedule Entitlement Cancellation POST Schedule the cancellation of the given Entitlement.
- Update seat for the active AZURE subscription PATCH Update the seat number for the active AZURE subscription.
- Unschedule Entitlement Cancellation POST Unschedule the cancellation of the given Entitlement.
Funding
- List the Organization's Funding Benefits GET List the AWS benefit wallets this organization holds — the funding AWS has set aside for it, and how much of…
- List Funding Applications GET List the organization's AWS funding applications: requests for funding programs such as MDF, POC, MAP…
- Create Funding Application POST Create an AWS funding application and send it to AWS Partner Central in the same call, or resubmit an…
- Save a Funding Application Draft POST Save an AWS funding application as a draft for a person to review.
- Preview Funding Application Field Mapping POST Prefill an AWS benefit application from one CRM opportunity, using the field mapping the organization…
- Validate Funding Application Payload POST Check an AWS benefit application against the rules AWS Partner Central applies on submission, without saving…
- Get Funding Application GET Get one AWS funding application by its Fours id, with the fields ListFundingApplications describes: `status`…
- Submit a funding application draft to AWS POST Send a draft saved by CreateFundingApplicationDraft to AWS Partner Central.
Metering
- Batch Report usageRecordGroups POST Batch report new usage record groups.
- Batch Validate usageRecordGroups POST Provide a batch of usage record groups and validate each individual usage record group one by one.
- List Billable Metrics GET list billable metrics for the given organization.
- Create Billable Metric POST Create a new billable metric for the given organization.
- Get Billable Metric GET Get the billable metric for the given organization and billable metric ID.
- Update Billable Metric PATCH Update the name, description and status of the billable metric for the given organization.
- Report usageRecordGroup POST Provide the ID in the request body CreateUsageRecordGroupParams so the report can be deduplicated.
- Get Usage Metering Config Info GET Get the usage metering config info of the given organization.
- Update Usage Metering Config Info PATCH Update the usage metering config info of the given organization.
- List usageRecordGroups GET List UsageRecordGroups by the given organization, partner, product, entitlement or buyer.
- Aggregate usageRecordGroups GET Aggregate usageRecordGroups by date and dimension key.
- Delete usageRecordGroup DELETE delete the UsageRecordGroup for the given organization and usageRecordGroup ID.
- Retry usageRecordGroup POST Retry the given UsageRecordGroup by setting from status "REPORT_FAILED" to "CREATED", and it will be ready…
- List usageRecordReports GET List usageRecordReports under the given organization, partner, entitlement or buyer, within the given time…
- Aggregate usageRecordReports GET Aggregate usageRecordReports by date and dimension key.
Notification
- Get Notification Config Info GET Get the notification config info of the given organization.
- Update Notification Config Info PATCH Update the notification config info of the given organization.
- List Notification Events GET List the notification events of the given organization with pagination and optional filters.
- List Notification Events by Entity GET List the notification events of the given organization and entity with pagination.
- List Notification Messages GET List or search the notification messages of the given organization with pagination.
- Get Notification Message GET Get the notification message of the organization & notification message ID.
Offer
- Create or Update Draft Offer POST Create a new draft offer or update the existing draft offer.
- List Offers GET List offers under the given organization with pagination and optional filter.
- Create Offer POST Create a private offer under the given organization.
- Query Offers GET Query offers with filtering, sorting, and pagination using CRUD query language.
- Get Offer GET Get the offer by the given offer ID.
- Delete Offer DELETE The offer is soft deleted (marked as DELETED status) in Fours service.
- Cancel Offer POST Only the offer with status = "PENDING_ACCEPTANCE", "PENDING_CANCEL", "ACTIVE" or "USED" is allowed to cancel.
- Get Offer EULA GET Get the EULA file of the given offer ID.
- Extend Offer Expiry Date POST Only the offer with status = "PENDING_ACCEPTANCE", "EXPIRED", "ACCEPTED" or "UPDATE_FAILED" is allowed to…
- Update Offer Meta Info PATCH Update the meta info of the given offer.
- Notify Offer Contacts POST Send offer notifications to the given contact ids.
- Get Offer PDF GET Render the offer's current terms (parties, dates, pricing, payment terms, marketplace details) as a shareable…
- Update Offer Pricing (Unified Format) PATCH Add new usage dimensions or update existing dimension rates (at negotiated rates) on a released AWS private…
- Get Offer Reseller EULA GET Get the Reseller EULA file of the given offer ID.
- Sync Offer POST Sync the given offer from its partner.
- Get Offer by External ID GET Get the offer by the given offer external ID.
OfferSet
- List Offer Sets GET List offer sets under the given organization with filtering, sorting, and pagination using CRUD query…
- Create Offer Set POST Create a new offer set under the given organization.
- Get Offer Set GET Get the offer set by the given offer set ID.
Operation
- List Operations with Filters POST List or search workflow operations with filter expressions.
- Get Operation Details GET Get the details of a Temporal workflow operation by operation ID.
- Get Operation History Events GET Get the history events for a Temporal workflow operation by operation ID.
Organization
- List organizations the current user or API client belongs to GET List all organizations (also known as accounts or tenants) that the authenticated caller has access to.
- Update the organization's onboarding intent (skip/dismiss). PATCH Updates the Get Started checklist intent for the organization.
- Get the organization's Get Started onboarding status. GET Returns the six-step Get Started checklist state (account, marketplace, crm, notification, readiness…
- Get the current organization's services and quotas GET Customer-facing read endpoint returning the requesting organization's services snapshot — every catalog…
- List Users by Organization GET List all users under the given organization.
Partner Relationship Management
- List Partner Relationships GET List the partner companies this organization has a relationship with, one row per partnership, with…
- Get One Partner Relationship GET Retrieve the full record for one partner relationship: company profile, relationship and engagement type…
- Update One Partner Relationship PATCH Update the editable fields of one partner relationship: the assigned partner manager, the relationship…
- List the people enrichment suggests at one partner company GET List the people company enrichment (Apollo or PDL) suggests at one partner company: name, email, job title…
- Add a contact at a partner POST Add a person to a partner's Relationship Hub contact list. `partnershipId` is the partnership id from…
- Edit a contact at a partner PATCH Edit a person on a partner's Relationship Hub contact list; fields you leave out stay as they are…
- Get One Partner's Commission Ledger GET Return the commission ledger for one partner from this organization's perspective: a record per closed-won…
- Get the PRM Program Dashboard GET Return one section of the partner program dashboard for an organization: the hero KPIs (active and suggested…
- Draft a Partnership Invitation Email POST Generate a subject line and body for a partnership invitation email, written for a specific recipient using…
- List the Organization's Partner Invitations GET List this organization's partner invitations, sent or received, each with its recipient, direction (outbound…
- Invite a contact to a partnership or a new partner POST Send a partner invitation: an email to a named recipient, and an invitation record in "Sent" state.
- Withdraw an invitation this organization sent POST Withdraw a partner invitation this organization sent, setting it to "Cancelled" and invalidating the accept…
- Resend a pending or expired partner invitation POST Re-send an invitation this organization sent, refreshing its accept-by date and re-delivering the original…
- Accept or decline an invitation this organization received POST Answer an invitation this organization received: an ISV's invitation to this partner organization, or a…
- Get the Partner Program Settings GET Return this organization's partner program settings as one object, kept in `info`: among them the journey…
- Update the Partner Program Settings PATCH Save this organization's partner program settings.
- List Partner Files GET List the files in this organization's partner file library, private ones included, with their name, category…
- Get one partner file with a download link GET Return one file from the partner file library with `downloadUrl`, a link to the file. `fileId` is the `id` of…
- List Partner Events GET List the partner events this organization runs and those shared with it by organizations whose partner…
- Create a Partner Event POST Create an event this organization runs for partners.
- Get One Partner Event GET Return one partner event this organization owns, or one shared with it by an organization whose partner…
- Edit a Partner Event PATCH Change one of this organization's events: fields you leave out stay as they are.
- List the RSVPs for an event GET List everyone who responded to one of this organization's events: the person (`responderName`), their…
- List Partner Agreements GET List partner agreements, newest first, each with its `type` (NDA, MSA, REFERRAL_AGREEMENT, SOW, OTHER)…
- Update a Partner Agreement PATCH Change an agreement's `status`, `name`, `type`, `effectiveDate` or `expiryDate`.
- List Partnership Tasks GET List the tasks this organization tracks with its partners.
- Create a task on a partnership POST Create a task on one partnership. `partnershipId` (from ListPrmPartnerships), `title` and `direction` are…
- Get One Partnership Task GET Return one partnership task with its subtasks and attached resources. `taskId` is the `id` of a row from…
- Edit a Partnership Task PATCH Change a task's title, description, priority, due date, assignees, tags, subtasks, resources or…
- Change a Partnership Task's Status POST Move a task to OPEN, IN_PROGRESS, BLOCKED or COMPLETED, sent as `to`, with the task's current `version` (from…
- List Partnership Task Templates GET List this organization's partnership task templates: reusable sets of tasks the team applies to partnerships.
- Assign a journey to a partner POST Assign one of this organization's journey templates to a partnership.
- List the journeys assigned to partners GET List the onboarding and enablement journeys assigned to this organization's partners, one row per assignment…
- Complete or reopen a journey step POST Set the status of one step of a journey assignment, sent as `to`: DONE completes it, NOT_STARTED or…
- List Partner Contacts GET The one list of the people at this organization's partners: the contacts Fours stores (added in the hub, from…
Product
- Create or Update Draft Product POST Create a new draft product or update the existing draft product.
- List Products by Partner GET List all products under the given organization and cloud partner.
- List Products GET List products under the given organization.
- Create Product POST create a new product in the marketplace.
- Query Products GET Query products with filtering, sorting, and pagination using CRUD query language.
- Get Product GET get product by product id
- Update Product PATCH update product info, no price update is allowed via this API.
- Delete Product DELETE The product is soft deleted (marked as DELETED status) in Fours service. only the products with non PUBLIC…
- List Metering Dimensions of Product GET list all metering dimensions of the given product
- Update Product Fulfillment URL PATCH update the fulfillment url of the given product
- Update Product Meta Info PATCH Update the meta info of the given product.
- Update Product Pricing (Unified Format) PATCH Update AWS or Azure product pricing with one partner-agnostic request (plans[] with commits + dimensions).
- Update Product Pricing PATCH update product pricing/terms info.
- Publish Product PATCH publish the given product to the public status in the marketplace
- Update Product Allowlist PATCH Replace the buyer AWS accounts allowlisted to view and subscribe to a Limited-visibility AWS SaaS listing…
Report
- List Daily Revenue Records GET List daily revenue records for an organization within a UTC date range of at most 4030 days.
- List Usage Metering Daily Records GET list the daily records of the usage metering from the cloud marketplace for the given organization…
Revenue
- List revenue record details by partner GET Returns the raw billing rows a marketplace partner reported for this organization, as a page with the total…
- Query Revenue Records GET Returns this organization's revenue records as a page, with the total count alongside them, so page_size=1…
- Total Revenue, Grouped POST Totals this organization's revenue in the database and returns the grouped amounts, answering "how much" in…
- List Cash Disbursements GET Returns this organization's cash disbursement rows as a page, with the total count and a summary alongside…
- List Accounts Receivable Invoices GET Returns this organization's accounts receivable invoices as a page, newest issue date first, with the total…
- List Credit Memos GET Returns this organization's credit memos as a page, with the total count alongside them: issued credit memos…
Support
- Create a support attachment before the ticket exists POST Stores a file against the organization, with no ticket, for an image pasted while a ticket is still being…
- List Support Tickets GET list support tickets
- Create Support Ticket POST create support ticket
- Get Support Ticket GET get support ticket
- Update Support Ticket PATCH update support ticket
- Create Support Ticket Attachment POST Attaches up to 10 files to the ticket, each posted to its timeline, up to 10 MiB each.
- Download Support Ticket Attachment GET Authenticated download of a support-ticket attachment (GitHub-Issues backend).
- Download a Support-Ticket File GET Downloads a GitHub Release file referenced by the ticket.
- Close Support Ticket PATCH close support ticket
- Create Support Ticket Comment POST create support ticket comment
- Reopen Support Ticket PATCH reopen support ticket
Training
- List Training Courses GET List training courses.
- Get One Training Course GET Return one course with its modules, lessons and settings. `courseId` is the `id` of a row from ListCourses.
- List Course Enrollments GET List course enrollments: send `courseId`, `mine=true`, or both (neither is a 400). `courseId` lists the…
- List Earned Certificates GET List earned certificates, newest first, including expired ones and ones replaced by a renewal (`status`…
- Get training progress across all partners GET Tally the courses this organization publishes across every partner, two ways over the same numbers: `courses`…
Spotted something wrong or out of date on this page? Tell us and we'll correct it.