v1
Get Consultation
API Documentation
- v1
- API Documentation
- How to Get Your API Tokens
- Authentication
- GETGet Company
- GETQuery Products
- GETGet Product
- POSTCreate Product
- POSTEdit Product
- GETDelete Product
- GETQuery Roles
- GETGet Role
- GETQuery Consultations
- GETGet Consultation
- POSTCreate Consultation
- POSTEdit Consultation
- GETQuery Assignments
- GETGet Assignment
- POSTCreate Assignment
- POSTAssign Assignment
- POSTEdit Assignment
- GETDelete Assignment
- GETQuery Clients
- GETGet Client
- POSTCreate Client
- POSTEdit Client
- GETDelete Client
- GETQuery Personnel
- GETGet Personnel
- POSTCreate Personnel
- POSTEdit Personnel
- GETDelete Personnel
v1
Get Consultation
Retrieves single consultation
GET
/
consultation
/
get
/
{company_slug}
/
{consultation_id}
curl --request GET \
--url https://api.hierarch.io/v1/consultation/get/{company_slug}/{consultation_id}/ \
--header 'token: <api-key>'
{
"consultation": {
"id": 123,
"status": "<string>",
"schedule": "<string>",
"location": "<string>",
"url": "<string>",
"title": "<string>",
"description": "<string>",
"notes": "<string>",
"product": {
"id": 123,
"name": "<string>",
"price": "<string>",
"currency": "<string>"
},
"datetime": "<string>"
},
"consultants": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"profile_photo": "<string>",
"role_name": "<string>"
},
"clients": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"profile_photo": "<string>"
}
}
Authorizations
API token provided to your company
Path Parameters
This is your company url
Consultation ID
Response
200
application/json
OK Response
Consultation ID
Status e.g. open/scheduled/closed
Schedule of the consultation
Physical location or online
URL
Title of the consultation
Description of the consultation
Internal notes
Date and time the consultation was created
Was this page helpful?
curl --request GET \
--url https://api.hierarch.io/v1/consultation/get/{company_slug}/{consultation_id}/ \
--header 'token: <api-key>'
{
"consultation": {
"id": 123,
"status": "<string>",
"schedule": "<string>",
"location": "<string>",
"url": "<string>",
"title": "<string>",
"description": "<string>",
"notes": "<string>",
"product": {
"id": 123,
"name": "<string>",
"price": "<string>",
"currency": "<string>"
},
"datetime": "<string>"
},
"consultants": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"profile_photo": "<string>",
"role_name": "<string>"
},
"clients": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"profile_photo": "<string>"
}
}