Borza Work API Reference Guide

Welcome to the Borza Work API! This guide provides all the necessary information you need to integrate with our API. It includes details about the API endpoints, sample requests and responses, and the process for feedback and support. This API allows you to retrieve active contracts and milestones, and create new milestones. For testing, we have provided two test contracts with IDs '33584333' and '33634399'. We look forward to your feedback and questions!

API Base URL

Production environment: https://work-api.borza.com

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".

Endpoints

GET /contracts/active

• Tags: contract
• Summary: Get active contracts
• Operation ID: getActiveContracts
• Parameters: platform (query, required): The platform (schema: string, enum = ['BORZA', 'UPWORK', 'FIVER', 'WORKSOME'])
• Sample Request:

GET /contracts/active?platform=BORZA

• Responses:
  • 200:
    • Description: Success
    • Schema: array of objects. Each object has the following properties: engagementStartDate (string), jobTitle (string), reference (string)
    • Sample Response:

    [
        {
            "engagementStartDate": "2021-07-22T00:00:00.000Z",
            "jobTitle": "Embedded login page with Python",
            "reference": "12345"
        }
    ]

GET /milestones/active

• Tags: milestone
• Summary: Get active milestone for a contract
• Operation ID: getActiveMilestones
• Parameters: contractReference (query, required): Contract reference (schema: string)
• Sample Request:

GET /milestones/active?contractReference=33584333

• Responses:
  • 200:
    • Description: Success
    • Schema: object with the following properties: contractId (string), depositAmount (string), description (string), dueDate (string), id (string)
    Sample Response:

    {
        "contractId": "214794",
        "depositAmount": "30",
        "description": "New description of milestone 2",
        "dueDate": "2023-05-20T00:00:00.000Z",
        "id": "11206"
    }

POST /milestones

• Tags: milestone
• Summary: Create a new milestone
• Operation ID: createMilestone
• Request Body (required): Milestone to be created (schema: object with the following properties: contractReference (string), milestoneDescription (string), depositAmount (string), dueDate (string))
• Sample Request:

POST /milestones
Content-Type: application/json
{
    "contractReference": "33584333",
    "milestoneDescription": "First milestone",
    "depositAmount": "50",
    "dueDate": "2023-12-12T00:00:00.000Z"
}

• Responses:
  • 200:
    • Description: Success
    • Schema: object with the following properties: id (string)
    • Sample Response:

    {
        "id": "123"
    }

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 jeremy@borza.com. Please include as much detail as possible about the issue or question.
3. Support: For immediate support or urgent issues, you can contact Jeremy via email (jeremy@borza.com) or WebEx.

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.

Lastly, for testing the POST /milestones endpoint, you can use the test contracts with IDs '33584333' and '33634399'.