/
/Shor Public API
ChangesDocsSign in
  • Docs
  • History
  • Schema
  • get/contractsList workspace contracts and optional deletion tombstones
  • post/contractsInitialize a draft for review and completion in Shor
  • get/businessGet the current workspace
  • get/contracts/{id}Get a workspace contract
  • get/timesheetsList workspace timesheets
  • get/timesheets/{id}Get a timesheet and its current approval version
  • post/timesheets/{id}/approveApprove a timesheet and create its scheduled payment
  • post/timesheets/{id}/rejectReject a submitted timesheet
  • get/contracts/{id}/milestonesList milestones for a workspace contract
  • get/milestones/{id}Get a milestone and its approval version
  • post/milestones/{id}/approveApprove a milestone, create a payment and attempt processing
  • post/milestones/{id}/rejectReject a submitted milestone
  • get/paymentsList workspace payments for reconciliation
  • get/payments/{id}Get current payment state
  • get/balancesGet available and pending workspace balances

Get the current workspace

get/business

Request

  • Base URL: https://api.shorpay.com/v1
  • URL: https://api.shorpay.com/v1/business
  • Auth: HTTP bearer

Response

Success

idstring uuid required
namestring required
countrystring required
kybStatusstring required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.