API docs by Redocly

People Cloud Public API (1.0.2)

Download OpenAPI specification:Download

A public API that lets client organizations retrieve profile info, create inquiries, and manage job positions.

User

Endpoints related to the authenticated user.

Get Current User Info

Returns the authenticated user's ID, name, email, and company name.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": 7,
  • "name": "Lawunn",
  • "email": "lawunnkhaing16@gmail.com",
  • "company": "La"
}

Inquiries

Create and manage inquiries.

Create a New Inquiry

Allows a client to submit a new inquiry with basic metadata and one or more position needs.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
title
required
string
description
string
required
object
main_contact
string
required
Array of objects (HirePosition)

Responses

Request samples

Content type
application/json
{
  • "title": "Fullstack Developer",
  • "description": "<div>Project to build backend system</div>",
  • "industry": {
    },
  • "main_contact": "Lawunn (lawunnkhaing16@gmail.com, +358402224007)",
  • "hires": [
    ]
}

Response samples

Content type
application/json
{
  • "inquiry_id": "inq_abc123",
  • "status": "draft"
}

List User's Inquiries

Retrieve a list of all inquiries created by the authenticated user.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "inquiries_total": 19,
  • "search_progress": 5,
  • "contracts_signed": 0,
  • "group_name": "@gmail.com",
  • "total": 5,
  • "orders": [
    ]
}

Cancel an Inquiry (order)

Cancel an entire inquiry (order) and all its positions. This public endpoint forwards the request to the internal user API and returns the internal response.

Authorizations:
ApiKeyAuth
path Parameters
orderId
required
integer

ID of the inquiry (order) to cancel

Responses

Response samples

Content type
application/json
{
  • "message": "Inquiry successfully cancelled"
}

Positions

Manage job positions attached to inquiries.

Get all positions for an inquiry

Retrieve the list of positions under a given inquiry ID.

Authorizations:
None
path Parameters
orderId
required
integer

ID of the inquiry (order)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a Position in an Inquiry

Cancels an existing position (hire) under a given inquiry (order) using the public API.

Authorizations:
ApiKeyAuth
path Parameters
orderId
required
integer

ID of the inquiry (order)

positionId
required
integer

ID of the position to cancel

Responses

Response samples

Content type
application/json
{
  • "message": "Position successfully canceled"
}

Add New Position to Inquiry

Adds a new job position to an existing inquiry.

Authorizations:
ApiKeyAuth
path Parameters
orderId
required
integer

ID of the inquiry to add the position to

Request Body schema: application/json
stage
required
string
title
required
string
type
required
string
experience_level
string
is_remote_work
string
budget
required
string
allocation
string
language_reqs
string
job_start
required
string <date-time>
job_end
required
string <date-time>
description
required
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "stage": "draft",
  • "title": "Backend Dev",
  • "type": "external",
  • "experience_level": "Intermediate",
  • "is_remote_work": "no",
  • "budget": "5000",
  • "allocation": "10",
  • "language_reqs": "Finnish",
  • "job_start": "2025-11-01T16:30:00.000Z",
  • "job_end": "2025-11-30T16:00:00.000Z",
  • "description": "<div>fx</div>",
  • "order_need_reqs": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "New position successfully added"
}