To get started with the Beeline API:

1. Set up your credentials:

   • For Beeline Enterprise Clients: Create a "Link" to a client in your Beeline Supplier Network application
   • For Beeline Professional Clients: A "Link" is created automatically for you.
   • Your administrator will provide you with a client_id and client_secret

2. Request an access token using one of these methods:

   • Basic Authentication: Include client_id:client_secret in Authorization header
   • Request Body: Send client_id and client_secret as form parameters

Example using Basic Auth:

Authorization: Basic base64(client_id:client_secret)
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials

The received token must be included in all subsequent API requests.

Returns all enterprise and professional clients that have an active connection with this supplier. Each client connection includes:

• Connection status and type
• Client name and identifiers
• VMS access details
• Connection establishment date

Use this endpoint to view your client relationships and obtain connection IDs needed for candidate submissions.

Retrieves comprehensive details about a specific job posting, including:

• Basic information (title, description, dates, location)
• Staffing requirements
• Rate information
• Custom fields

Use this endpoint to get all necessary information before creating a candidate submission.

Returns job postings that have been made available to the supplier by enterprise VMSs.

Important Note

This endpoint only returns job postings that were opened/released after establishing a link with the enterprise VMS. Any job postings that existed before the link was created must be accessed through the web application.

List all candidates that a supplier has created. Can be filtered per job posting.

Overview

Creates a new candidate record by associating a worker with a job posting. This is the second step in the candidate submission workflow.

Prerequisites

1. An existing worker profile (POST /workers)
2. An active job posting
3. Required custom fields (check /candidates/metadata endpoint)

What This Endpoint Does

• Associates a worker with a job posting
• Creates a candidate record with 'CREATED' status
• Allows setting of required and optional fields
• Enables attachment of supporting documents

Important Notes

• Candidate is NOT yet visible in the VMS
• Address Line 1 is required to submit the candidate when submitting to Beeline Enterprise
• Candidate must be explicitly submitted later using /candidates/{uid}/submit
• All required fields should be completed before submission
• Custom fields vary by job posting and client

Best Practices

1. Check job posting requirements first
2. Verify worker profile exists
3. Validate all required fields
4. Complete all information before submission
5. Review custom field requirements

Next Steps

After successful creation, use the submit endpoint to make the candidate visible in the VMS.

⚠️ Important: Beeline Professional Only

This operation is only available for Beeline Professional job postings. Enterprise posting candidates must be rescinded through the web application.

Overview

Withdraws a previously submitted candidate from consideration in the VMS system.

Effects of Rescinding

1. Candidate removed from VMS consideration
2. Status returns to editable state
3. Details can be updated
4. Can be resubmitted to same posting

Common Use Cases

• Correct submission errors
• Update candidate information
• Withdraw consideration
• Resubmit with changes

Process Flow

1. Rescind candidate
2. Make necessary updates
3. Resubmit if desired
4. Monitor new submission

Notes

• Verify posting type before attempting
• Cannot rescind Enterprise candidates

Overview

Submits a candidate for consideration, making them visible in the VMS system. This is the final step in the candidate submission process.

Prerequisites

1. Worker profile must exist
2. Candidate must be created
3. All required fields must be completed
4. Custom fields must be validated

Platform-Specific Requirements

Beeline Enterprise Postings:

• Requires supplierEnterpriseConnectionUid

Beeline Professional Postings:

• No connection UID required
• Can be rescinded via API
• Supports resubmission after rescinding

Important Notes

• Verify all information before submitting
• Cannot update after submission
• Check posting type for requirements

Best Practices

1. Validate all required fields
2. Check custom field requirements
3. Verify rates and dates
4. Test in non-production first

Overview

Retrieves detailed information about a specific candidate, including their current status, submission details, and associated data.

Common Use Cases

• Check submission status
• Review candidate details
• Monitor candidate progress

Notes

• Requires valid candidate UID
• Returns 404 if candidate not found
• Shows current submission state

Overview

Updates information for an existing candidate.

Important Restrictions

• Can only update candidates in 'CREATED' status
• Cannot update submitted candidates
• Must rescind submitted candidates before updating
• All required fields must remain valid

Best Practices

1. Verify candidate status before updating
2. Check required fields
3. Validate all data before submission
4. Keep original required fields

Removes attached media files (such as resumes or other documents) from a candidate's profile.

Supported Media Types

• Resumes
• Supporting documents
• Other candidate attachments

Important Notes

• Operation cannot be undone
• Requires both candidate UID and media UID
• Returns 404 if either UID is invalid

Upload documents for a candidate using multipart form data. This endpoint allows direct file uploads through form submission.

Required Parameters

• uid (path): The unique identifier of the candidate
• file: The document to be uploaded (binary format)
• filename: Name of the file
• mediaType: Document classification, one of:
  • RESUME: Candidate's resume/CV
  • OTHER_WORKER_DOCUMENT: Supporting documentation

Example Usage

POST /api/gwg/supplier/candidates/{uid}/media/multipart
Content-Type: multipart/form-data

file: [binary content]
filename: resume.pdf
mediaType: RESUME

Notes

• Uses standard multipart/form-data encoding for file uploads
• Each file must be classified with the appropriate mediaType
• The candidate must exist (identified by uid) before uploading

Add candidate media for a specific candidate.

Get candidate media for a specific candidate.

Retrieves the custom field configuration for a candidate. Since each enterprise client can define their own required fields, use this endpoint to determine:

• Which custom fields are available
• Which fields are required for submission
• Any predefined values for dropdown/selection fields

List all of the workers that have been previously added by the supplier.

Get worker details for a specific worker.

Update worker details for a specific worker.