v1
Query Assignments
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
Query Assignments
Retrieves assignment array
GET
/
assignment
/
query
/
{company_slug}
curl --request GET \
--url https://api.hierarch.io/v1/assignment/query/{company_slug}/ \
--header 'token: <api-key>'
{
"loop": [
{
"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>"
}
]
}
],
"current_page": "<string>",
"max_page": "<string>",
"start_count": "<string>",
"end_count": "<string>",
"max_count": "<string>"
}
Authorizations
API token provided to your company
Headers
Search term, blank by default
Page number, 1 by default
Data order - newest / oldest
Path Parameters
This is your company url
Response
200
application/json
OK Response
Assignment ID
Assignment title
Assignment description
Assignment status
Assignment remarks
Current data page
Maximum number of pages
Starting data count
Ending data count
Maximum number of data
Was this page helpful?
curl --request GET \
--url https://api.hierarch.io/v1/assignment/query/{company_slug}/ \
--header 'token: <api-key>'
{
"loop": [
{
"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>"
}
]
}
],
"current_page": "<string>",
"max_page": "<string>",
"start_count": "<string>",
"end_count": "<string>",
"max_count": "<string>"
}