Some account have access to CONQA's API as part of their subscription. If you are not sure whether this applies to your company, please contact your account manager, or reach out to our support ream via support@conqahq.com, or via Live Chat.
This is the public API for CONQA.
Getting Started with the API
The Public API is available at:
https://api-oceania.con.qa/api-v1
To get started, you'll need to:
Generate an API token from your user settings in CONQA Console
Include your API token in the Authorization header for all API requests
Endpoints
Get Projects for User
Retrieves a list of all projects that you have access to in licensed accounts.
GET https://api-oceania.con.qa/api-v1/projects
Authorization: your-api-token-here
Example Response
{
"projects": [
{
"projectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"projectName": "CONQA Apartments"
},
{
"projectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"projectName": "CONQA Office Upgrade"
}
]
}Get Project Summary
Retrieves the summary information for a specific project that you have access to, including the project name and issue statistics.
GET https://api-oceania.con.qa/api-v1/project/{projectId}/summary
Authorization: your-api-token-hereParameters
projectId (path parameter): The unique identifier of the project
Example Response
{
"data": {
"name": "CONQA Apartments",
"issues": {
"total": 10,
"statuses": [
{
"name": "open",
"issueCount": 45
},
{
"name": "closed",
"issueCount": 33
},
{
"name": "disputed",
"issueCount": 3
},
{
"name": "ready-to-inspect",
"issueCount": 4
},
{
"name": "work-completed",
"issueCount": 12
}
]
}
}
}Get Project Issues
Retrieves a list of issues for a specific project that you have access to, with pagination support.
GET https://api-oceania.con.qa/api-v1/project/{projectId}/issues
Authorization: your-api-token-hereParameters
projectId (path parameter): The unique identifier of the project
page (query parameter, optional): The page number to retrieve (default: 1)
limit (query parameter, optional): The number of issues per page (default: 10)
Example Response
{
"data": {
"paging": {
"total_records": 112,
"page_size": 10,
"page_number": 1
},
"issues": [
{
"issueId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"projectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"assignedTo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"checklistId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"checkpointId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"description": "Test issue description",
"dueDate": "2023-12-30T11:00:00.000Z",
"issueNumber": "ISS-22",
"lastUpdatedAt": "2024-10-21T12:38:02.959Z",
"lastUpdatedBy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"raisedAt": "2024-10-21T12:38:02.959Z",
"raisedBy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"raisedByName": "John Doe",
"responsiblePerson": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"responsiblePersonName": "Jane Smith",
"status": "open",
"title": "Test issue",
"daysAtStatus": 3,
"ballInCourtUser": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"ballInCourtUserName": "John Doe",
"numberOfAttachments": 2
}
]
}
}Error Responses
The API uses standard HTTP status codes to indicate success or failure:
200: Success
400: Bad Request
401: Unauthorized (invalid or missing API token)
403: Forbidden
404: Not Found
500: Internal Server Error