This method allows you to fetch all your projects within your organization.
Responses are sorted newest to oldest
This method will return up to 500 responses at a time and you can use paging to fetch additional items.
The paging field in the response includes total which contains the total number of responses available and last_page which is the highest page number which would contain results.
Parameters
Your request data may contain the following parameters. GET or POST the object (as JSON) tohttps://api.kpaehs.com/v1/projects.list.
| Parameter | TypeScript | Example | Required | Description |
|---|---|---|---|---|
token |
string |
"YOUR_TOKEN" |
Required | Your API Token |
pretty |
boolean |
true |
Optional | true means the response json will include white space for readability. Default is false. |
limit |
number |
100 |
Optional | The maximum number of responses to return. Max 500. Defaults to 10. Use page to fetch additional responses. |
page |
number |
1 |
Optional | The page of responses to return. Defaults to 1. The response field paging.last_page tells you what the last valid page number is. |
Example Request
Example Response
{
"projects": [
{
"id": 8,
"created": "1709784464569",
"updated": "1709784464569",
"deleted": false,
"name": "Project 4",
"number": "4",
"address": "1234 Street",
"city": "Apple",
"state": "CA",
"zip": "12345",
"notes": "zxczxczxczx",
"attachments": []
},
{
"id": 7,
"created": "1709708557746",
"updated": "1709708557746",
"deleted": false,
"name": "Project 3",
"number": "3",
"address": "1234 Street",
"city": "Apple",
"state": "CA",
"zip": "12345",
"notes": "zxczxczxczxc",
"attachments": []
}
],
"paging": {
"total": 32,
"last_page": 16
},
"ok": true
}
Errors
If an error occurs, the response JSON will have ok set to false:
{
"ok": false,
"error": "token_invalid",
"description": "The token `YOUR_TOKEN` was not found."
}
The error field will contain one of the following error identifiers and there
may also be a description field with a more detailed explanation:
| Identifier | Description |
|---|---|
api_method_not_found |
The requested url did not match any KPA Flex API method. |
request_method_invalid |
The requested method was not GET or POST. |
request_data_invalid |
The request did not include a valid JSON request object. |
rate_limit_exceeded |
This token is exceeding its request limit. |
token_missing |
The request did not include a token. |
token_invalid |
The request token was invalid. |
token_inactive |
The request token was has been deactivated. |
token_permission |
The request token does not have write permission. |
account_inactive |
The request token was for an account that is not active. |
parameter_unexpected |
The request data included a parameter that is not supported. |
parameter_missing |
The request data failed to include a parameter which was required. |
parameter_invalid |
The request data included a parameter which had a value that is not allowed. |
server_error |
The server encountered an internal error. |
content_not_found |
The requested content was not found. |