Tutorial: Get Inquiries List

This tutorial guides you through how to retrieve the list of existing inquiries using the public API endpoint. It provides basic metadata about each inquiry, such as title, description, stage, and job timeline.

---

Step 1: Fetch Inquiries

Use this endpoint to retrieve all visible inquiries for the authenticated user.

Endpoint

GET /api/public/inquiries

---

Authorization

This endpoint requires authentication. Use the Bearer token received from login or session.

Request Headers

Authorization: Bearer <your_token_here>
Accept: application/json

---

Example cURL Command

curl -X GET http://127.0.0.1:8000/api/public/inquiries \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" 

---

Step 2: Response Structure

Sample Response

{
  "inquiries_total": 19,
  "search_progress": 5,
  "contracts_signed": 0,
  "group_name": "@gmail.com",
  "total": 5,
  "orders": [
    {
      "id": 16,
      "title": "Software Dev",
      "description": "fx",
      "industry": "Software",
      "stage": "pending",
      "job_start": "2025-11-01 15:00:00",
      "job_end": "2025-11-30 15:00:00",
      "created_at": "2025-11-06T12:33:32.000000Z",
      "updated_at": null
    },
    {
      "id": 14,
      "title": "Full",
      "description": "fx",
      "industry": "Software",
      "stage": "pending",
      "job_start": "2025-11-01 15:00:00",
      "job_end": "2025-11-30 15:00:00",
      "created_at": "2025-11-03T09:29:45.000000Z",
      "updated_at": null
    },
    ...
  ]
}

---

Step 3: Key Fields Explained

Field	Description
id	Unique ID of the inquiry
title	Title of the inquiry (e.g., job role or project name)
description	Short HTML or text description
industry	Sector or category (e.g., Software, Healthcare)
stage	Current inquiry status (pending, searching, etc.)
job_start	Expected start date of the role
job_end	Expected end date of the role
created_at	Timestamp when inquiry was created

---

Step 4: Use Cases

• Populate a dashboard of open inquiries
• Filter inquiries by stage or timeline
• Select inquiry ID for adding new positions
• Monitor progress or audit inquiry history

---

Step 5: Error Responses

Status	Meaning	Description
200	OK	Inquiry list successfully retrieved
401	Unauthorized	Missing or invalid Bearer token
403	Forbidden	You don’t have permission to view inquiries

---