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/v1/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 https://your-domain.com/api/v1/inquiries \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" 

---

Step 2: Response Structure

Sample Response

{
  "inquiries_total": 1,
  "search_progress": 1,
  "contracts_signed": 0,
  "group_name": "@gmail.com",
  "total": 1,
  "per_page": 10,
  "current_page": 1,
  "last_page": 1,
  "from": 1,
  "to": 1,
  "orders": [
    {
      "id": 29,
      "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": "2026-06-08T18:29:18.000000Z",
      "updated_at": null,
      "positions": [
        { "id": 38, "title": "Dev" },
        { "id": 39, "title": "Hello Dev" }
      ]
    },
    ...
  ]
}

---

Step 3: Key Fields Explained

Envelope / Pagination

Field	Description
inquiries_total	Total number of inquiries owned by the user
search_progress	Number of inquiries currently in progress
contracts_signed	Number of signed contracts related to the user
group_name	Name/identifier of the user's group (if any)
total	Total inquiries after filtering
per_page	Number of results per page
current_page	The current page number
last_page	Total number of pages
from / to	Item range shown on the current page

Order (Inquiry) Object

Field	Description
id	Unique ID of the inquiry
title	Title of the inquiry
description	Plain-text description (HTML stripped)
industry	Sector or category (e.g., Software, Healthcare)
stage	Current inquiry status (e.g., pending)
job_start	Expected start date (from the first linked position)
job_end	Expected end date (from the first linked position)
created_at	Timestamp when the inquiry was created
updated_at	Timestamp of the last update
positions	Array of all positions linked to this inquiry — each contains id and title only

---

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

---