In this article, you can read about how to retrieve, create, update, and delete inquiries via the API, how to attach a contact to an inquiry, and how to retrieve inquiry settings such as tags, types, and statuses.
Get Inquiry
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=inquiry&page=1&archived=0The GET method is used for retrieving data for inquiries.
| URL | https://api.recman.io/v2/get/ |
| Scope | inquiry |
| Page | Page number, 100 inquiries per page |
| Archived | Optional, see description below |
Note
archived is optional. Value 0 will only list inquiries that are not archived. archived = 1 will ONLY list archived inquiries.
PARAMS
| key | {{api_key}} |
| scope | inquiry |
| page | 1 |
| archived | 0 |
Inquiry fields returned
| Field | Description |
|---|---|
| inquiryId integer |
ID of the inquiry |
| inquiryNumber integer |
Sequential number of the inquiry |
| name string |
Name of the inquiry |
| body string |
Body text of the inquiry |
| created datetime |
Date and time the inquiry was created |
| updated datetime |
Date and time the inquiry was last updated |
| deadline string |
Deadline set for the inquiry, if any |
| inquiryStatusId integer |
ID of the inquiry status. Resolve against Inquiry Settings below |
| inquiryTypeId integer |
ID of the inquiry type. Resolve against Inquiry Settings below |
| read integer |
Whether the inquiry has been read. Valid values: 1, 0 |
| archived integer |
Whether the inquiry is archived. Valid values: 1, 0 |
| userIds array of integer |
List of user IDs associated with the inquiry |
Get Inquiry Settings
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=inquirySettingsTo list settings from inquiries in RecMan, such as tags, inquiry type, and status, use the scopeinquirySettings. This lists the IDs needed to insert or update an inquiry with the right tags, type, and status.
Note
You can view and edit inquiry tags, types, and statuses directly in RecMan, in the top left corner of the inquiry page.
| URL GET | https://api.recman.io/v2/get/ |
| Scope | inquirySettings |
PARAMS
| key | {{api_key}} |
| scope | inquirySettings |
Response groups returned
| Group | Description |
|---|---|
| inquiryTags | List of available inquiry tags, each with an ID and name |
| inquiryStatus | List of available inquiry statuses, each with an ID and name |
| inquiryTypes | List of available inquiry types, each with an ID and name |
Insert / Update / Delete Inquiry
POST
https://api.recman.io/v2/post/The POST method is used for inserting, updating, and deleting inquiries. All three operations share the same fields below.
| URL POST | https://api.recman.io/v2/post/ |
| Scope | inquiry |
| Operation | insert / update / delete |
Fields
| Field | Description |
|---|---|
| inquiryId integer |
Required on operation: update, delete |
| name string |
Name of the inquiry |
| body string |
The inquiry body text |
| contact object |
See Adding a Contact to an Inquiry below |
| userIds array of integer |
List of user IDs |
| companyIds array of integer |
List of company IDs |
| companyContactIds array of integer |
List of company contact IDs |
| candidateIds array of integer |
List of candidate IDs |
| projectIds array of integer |
List of project IDs |
| inquiryStatusId integer |
Inquiry status ID. Resolve valid IDs via the Inquiry Settings scope |
| inquiryTypeId string |
Inquiry type ID. Resolve valid IDs via the Inquiry Settings scope |
| inquiryTagIds array of integer |
List of inquiry tag IDs. Resolve valid IDs via the Inquiry Settings scope |
Request Body — Insert
| key | {{api_key}} |
| scope | inquiry |
| operation | insert |
| data.name | RecMan |
| data.body | The POST method is used for inserting, updating and deleting inquiries. |
| data.userIds | [13236] |
| data.companyIds | [1055074, 753443] |
| data.candidateIds | [3772436, 3776359] |
| data.projectIds | [742171, 776961] |
Request Body — Update
| key | {{api_key}} |
| scope | inquiry |
| operation | update |
| data.inquiryId | 96547 |
| data.name | RecMan (updated) |
Request Body — Delete
| key | {{api_key}} |
| scope | inquiry |
| operation | delete |
| data.inquiryId | 96547 |
Adding a Contact to an Inquiry
POST
https://api.recman.io/v2/post/A contact — with company and personal details — can be attached to an inquiry by including acontact object in the insert request. This is typically used when the inquiry comes from an external, unregistered contact rather than an existing candidate or company contact.
Contact — sub-fields
| Field | Description |
|---|---|
| inquiryId string |
Inquiry ID |
| companyName string |
Company name |
| vatNumber string |
VAT number |
| name string |
Contact's name |
| officePhone string |
Office phone number |
| mobilePhone string |
Mobile phone number |
| email string |
Email address |
Request Body
| key | {{api_key}} |
| scope | inquiry |
| operation | insert |
| data.name | RecManXL |
| data.contact.companyName | Gussi |
| data.contact.vatNumber | 96 |
| data.contact.name | Gussi |
| data.contact.officePhone | 123456789 |
| data.contact.mobilePhone | +480123456789 |
| data.contact.email | gussi@example.com |