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 Assignment
Retrieves single assignment record
GET
/
assignment
/
get
/
{company_slug}
/
{assignment_id}
curl --request GET \
--url https://api.hierarch.io/v1/assignment/get/{company_slug}/{assignment_id}/ \
--header 'token: <api-key>'
{
"assignment": {
"id": 123,
"title": "<string>",
"description": "<string>",
"status": "<string>",
"remarks": "<string>",
"product": {
"id": 123,
"name": "<string>"
},
"pipeline": {
"id": 123,
"name": "<string>"
}
},
"handbooks": [
{
"id": 123,
"title": "<string>",
"slug": "<string>"
}
],
"clients": [
{
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"profile_photo": "<string>"
}
],
"personnel": [
{
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"role_name": "<string>"
}
]
}
Authorizations
API token provided to your company
Path Parameters
This is your company url
Assignment ID
Response
200
application/json
OK Response
Assignment ID
Assignment title
Assignment description
Assignment status
Assignment remarks
Was this page helpful?
curl --request GET \
--url https://api.hierarch.io/v1/assignment/get/{company_slug}/{assignment_id}/ \
--header 'token: <api-key>'
{
"assignment": {
"id": 123,
"title": "<string>",
"description": "<string>",
"status": "<string>",
"remarks": "<string>",
"product": {
"id": 123,
"name": "<string>"
},
"pipeline": {
"id": 123,
"name": "<string>"
}
},
"handbooks": [
{
"id": 123,
"title": "<string>",
"slug": "<string>"
}
],
"clients": [
{
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"profile_photo": "<string>"
}
],
"personnel": [
{
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"role_name": "<string>"
}
]
}