<aside> ❗ WORK API is currently available by invite only. Request an invite by emailing invite@borza.com.

</aside>

Work API

Introduction to Work API

The reference is your key to a comprehensive understanding of the Borza Work API. It includes details about endpoints, sample requests and responses, and the process for feedback and support.

This API allows you to create and interact with contracts and milestones programmatically.

<aside> ❗ For testing, we have provided two test contracts with IDs 33584333 and 33634399.

</aside>

Conventions

HTTPS is required for all API requests. The base URL to send all API requests is:

[**<https://work-api.borza.com>**](<https://work-api.borza.com>)

The Work API follows RESTful conventions when possible, with most operations performed via GET, POST, and PUT requests on tasks and contract resources.

Security

This API uses an API key for security. The API key should be included in the header of each request with the name

X-BORZA-API-KEY

Enums

export enum OfferMilestoneStateEnum {
  NOT_FUNDED = 'NotFunded',
  IN_OFFER = 'InOffer',
  ACTIVE = 'Active',
  SUBMITTED = 'Submitted',
  REJECTED = 'Rejected',
  REJECTED_BY_SYSTEM = 'RejectedBySystem',
  PAID = 'Paid',
  PAID_BY_SYSTEM = 'PaidBySystem',
  NOT_FUNDED_CLOSED = 'NotFundedClosed',
  CANCELLED_BY_CLIENT = 'CancelledByClient',
  CANCELLED_BY_FREELANCER = 'CancelledByFreelancer',
  CANCELLED_BY_SYSTEM = 'CancelledBySystem',
  OFFER_CANCELLED = 'OfferCancelled',
}

End Points

GET /contracts/active

GET /contracts/{contractId}

GET /milestones/active

POST /milestones

PUT /milestones/{milestoneId}

PUT /milestones/{milestoneId}/approve

Feedback and Support

For providing feedback, raising issues, or asking questions, please follow this process:

1. WebEx Space: Any questions, issues, or feedback can be posted on the WebEx Space "work-api.borza.com". This is a dedicated space for discussions related to this API.
2. Email: If you prefer email, you can reach out to support@borza.com. Please include as much detail as possible about the issue or question.

When providing feedback, please include details such as the endpoint you're testing, the request you're sending, the response you're getting, and the issue you're experiencing. If possible, include any error messages and screenshots as well.