Projects Details

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	projects.json
General	Yes	Parameters described in overview	see overview	Structure of an API call
Model Structure	Yes	Name of model required	modelstructure=projectdetails	Using data models
View	No	Stored filter applied		Using views
Sort	No	Change the view's default sort order	sort=CREATED	Sorting
Filters	No	Filter by a key field		Filters
Company	Yes	The company number	company=1
Identifier	Yes	Project ID or UUID	project=232
Client	Yes	Client ID	client=1/A001

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/projects.json?&version=6&company=43&modelstructure=projectdetails&project=232

Example request (legacy username/password):

http://<SERVER>/jsonapi/projects.json?&version=6&company=43&modelstructure=projectdetails&project=232&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 7,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synversion": "15.000.0017",
  "synapiversion": 6,
  "data": [
    {
      "projectuuid": "C1A3B79859907042A8F93A8B03F98242",
      "projectTimeStampModified": 1752837383,
      "projectRecordVersionNumber": 1,
      "projectClientCode": "",
      "projectClientName": "",
      "projectCompany": 43,
      "projectCompanyName": "Mike's test co (43)",
      "projectCreatedDate": "2025-07-18",
      "projectCreatedTime": "12:14:36",
      "projectCreatedUserID": 5,
      "projectCreatedBy": "Mike Pender",
      "projectHandlerName": "Mike Pender",
      "projectCompleted": false,
      "projectNotes": "",
      "projectBudget": 0,
      "projectName": "My Project",
      "projectNo": 232,
      "projectHandlerUserID": 5
    }
  ]
}