Get List Of IntelliAppZ by Id

Overview

Retrieves a list of IntelliAppZ by its AppZ ID. This endpoint returns the IntelliAppZ configurations associated with the specified AppZ ID for the authenticated partner. The response can optionally be filtered by unit type or version.

Endpoint Details

URL:

/api/integration/partner/appz/byId?

Method :

GET

{'Content-Type': 'application/json; charset=utf-8'}

Query Parameter:

Name	In	Description
appzId	query	The unique identifier of the IntelliAppZ to retrieve.
unitType	query	An optional parameter to filter results by unit type.
version	query	An optional parameter to filter results by version.

Response:

HTTP Status Codes

Success Response

Status	Description
200	The list of the IntelliAppZ are retrieved successfully.

Error Responses

Status	Description
400	Bad Request – The partner ID or user ID is invalid.
401	Unauthorized – Authentication is required to access this resource.
403	Forbidden – The user lacks IntelliAppZ access or is not authenticated as a partner.
404	Not Found – No partner record is associated with the authenticated user.
500	Internal Server Error – An unexpected error occurred during request processing.

Response Body

With Only appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5

appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5

  https://accounts.onintellibuddies.com/api/integration/partner/appz/byId?appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5

{
  "partner": {
    "partnerId": 1,
    "firstName": "Hank",
    "lastName": "Pym",
    "emailAddress": "partner@local.com",
    "phone": "+12129704133",
    "jobTitle": "CEO",
    "companyName": "Pym Technologies",
    "country": "United States",
    "city": "California",
    "industry": "Pharma",
    "businessRegion": "North America;#South America;#Western America;#Eastern America",
    "partnerType": "Implementation Partner",
    "status": "Active",
    "number": "IBPR20241217000001",
    "state": null,
    "postalCode": null,
    "address": null,
    "created": "2024-12-17T02:13:18.868908",
    "modified": "2024-12-17T02:14:29.522617",
    "createdBy": "Administrator ",
    "modifiedBy": "Sales manager"
  },
  "intelliAppZ": [
    {
      "intelliAppzId": 4,
      "name": "Sample",
      "id": "4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5",
      "version": "1.0.0",
      "unitType": "execution",
      "description": "for testing",
      "reviewerComment": "for testing",
      "status": "Published",
      "isHavingSubscription": true,
      "creditMappings": [],
      "created": "2025-03-13T09:38:30.218324",
      "modified": "2025-04-04T07:26:12.124245",
      "createdBy": "Hank Pym",
      "modifiedBy": "RM User"
    },
    {
      "intelliAppzId": 7,
      "name": "Sample",
      "id": "4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5",
      "version": "1.0.1",
      "unitType": "execution",
      "description": "for testing",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": false,
      "creditMappings": [],
      "created": "2025-04-22T05:59:47.699563",
      "modified": "2025-04-22T05:59:47.699563",
      "createdBy": "Hank Pym",
      "modifiedBy": "Hank Pym"
    },
    {
      "intelliAppzId": 8,
      "name": "Sample",
      "id": "4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5",
      "version": "1.0.1",
      "unitType": "page",
      "description": "for testing",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": false,
      "creditMappings": [],
      "created": "2025-04-22T06:00:02.686296",
      "modified": "2025-04-22T06:00:02.686296",
      "createdBy": "Hank Pym",
      "modifiedBy": "Hank Pym"
    }
  ]
}

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, unittype=page

unittype=page

  https://accounts.onintellibuddies.com/api/integration/partner/appz/byId?appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5&unittype=page

{
  "partner": {
  "partnerId": 2,
  "firstName": "partner",
  "lastName": "ibqa",
  "emailAddress": "ibqamegha@gmail.com",
  "phone": "+919380789538",
  "jobTitle": "Software Engineer",
  "companyName": "IB",
  "country": "India",
  "city": "Bangalore Urban",
  "industry": "Arts and Design",
  "businessRegion": "India",
  "partnerType": "Implementation Partner",
  "status": "Active",
  "number": "IBPR20250130000002",
  "state": null,
  "postalCode": null,
  "address": null,
  "created": "2025-01-30T08:50:14.519304",
  "modified": "2025-01-31T06:49:57.72202",
  "createdBy": "System Account",
  "modifiedBy": "Sales Manager ibqa"
  },
  "intelliAppZ": [
    {
      "intelliAppzId": 205,
      "name": "Page",
      "id": "4B5260EB-3CDC-4D70-BA23-C323119D49D3",
      "version": "1.0.1",
      "unitType": "page",
      "description": "",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": false,
      "creditMappings": [],
      "created": "2025-05-06T10:47:01.699062",
      "modified": "2025-05-06T10:47:01.699062",
      "createdBy": "partner ibqa",
      "modifiedBy": "partner ibqa"
    }
  ]
}

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, unittype=execution

unittype=execution

  https://accounts.onintellibuddies.com/api/integration/partner/appz/byId?appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5&unittype=execution

{
  "partner": {
  "partnerId": 2,
  "firstName": "partner",
  "lastName": "ibqa",
  "emailAddress": "ibqamegha@gmail.com",
  "phone": "+919380789538",
  "jobTitle": "Software Engineer",
  "companyName": "IB",
  "country": "India",
  "city": "Bangalore Urban",
  "industry": "Arts and Design",
  "businessRegion": "India",
  "partnerType": "Implementation Partner",
  "status": "Active",
  "number": "IBPR20250130000002",
  "state": null,
  "postalCode": null,
  "address": null,
  "created": "2025-01-30T08:50:14.519304",
  "modified": "2025-01-31T06:49:57.72202",
  "createdBy": "System Account",
  "modifiedBy": "Sales Manager ibqa"
  },
  "intelliAppZ": [
    {
      "intelliAppzId": 196,
      "name": "t1",
      "id": "4B5260EB-3CDC-4D70-BA23-C323119D49D3",
      "version": "1.0.0",
      "unitType": "execution",
      "description": "",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": true,
      "creditMappings": [],
      "created": "2025-04-30T08:52:05.462096",
      "modified": "2025-04-30T08:52:05.462096",
      "createdBy": "partner ibqa",
      "modifiedBy": "partner ibqa"
    }
  ]
}

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, unittype=conversation

unittype=conversation

  https://accounts.onintellibuddies.com/api/integration/appz/partner/byId?appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5&unittype=conversation

"partner": {
  "partnerId": 2,
  "firstName": "partner",
  "lastName": "ibqa",
  "emailAddress": "ibqamegha@gmail.com",
  "phone": "+919380789538",
  "jobTitle": "Software Engineer",
  "companyName": "IB",
  "country": "India",
  "city": "Bangalore Urban",
  "industry": "Arts and Design",
  "businessRegion": "India",
  "partnerType": "Implementation Partner",
  "status": "Active",
  "number": "IBPR20250130000002",
  "state": null,
  "postalCode": null,
  "address": null,
  "created": "2025-01-30T08:50:14.519304",
  "modified": "2025-01-31T06:49:57.72202",
  "createdBy": "System Account",
  "modifiedBy": "Sales Manager ibqa"
},
"intelliAppZ": [
    {
      "intelliAppzId": 206,
      "name": "conversations",
      "id": "4B5260EB-3CDC-4D70-BA23-C323119D49D3",
      "version": "2.0.1",
      "unitType": "conversation",
      "description": "",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": false,
      "creditMappings": [],
      "created": "2025-05-06T10:47:29.831101",
      "modified": "2025-05-06T10:47:29.831101",
      "createdBy": "partner ibqa",
      "modifiedBy": "partner ibqa"
    }
  ]
}

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, version=1.0.0

version=1.0.0

  https://accounts.onintellibuddies.com/api/integration/partner/appz/byId?appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5&version=1.0.0

{
  "partner": {
  "partnerId": 2,
  "firstName": "Megha",
  "lastName": "ibqa",
  "emailAddress": "ibqamegha@gmail.com",
  "phone": "+919380789538",
  "jobTitle": "Software Engineer",
  "companyName": "IB",
  "country": "India",
  "city": "Bangalore Urban",
  "industry": "Arts and Design",
  "businessRegion": "India",
  "partnerType": "Implementation Partner",
  "status": "Active",
  "number": "IBPR20250130000002",
  "state": null,
  "postalCode": null,
  "address": null,
  "created": "2025-01-30T08:50:14.519304",
  "modified": "2025-01-31T06:49:57.72202",
  "createdBy": "System Account",
  "modifiedBy": "Sales Manager ibqa"
  },
"intelliAppZ": [
    {
      "intelliAppzId": 196,
      "name": "t1",
      "id": "4B5260EB-3CDC-4D70-BA23-C323119D49D3",
      "version": "1.0.0",
      "unitType": "execution",
      "description": "",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": true,
      "creditMappings": [],
      "created": "2025-04-30T08:52:05.462096",
      "modified": "2025-04-30T08:52:05.462096",
      "createdBy": "Megha ibqa",
      "modifiedBy": "Megha ibqa"
    },
    {
      "intelliAppzId": 207,
      "name": "execution_version",
      "id": "4B5260EB-3CDC-4D70-BA23-C323119D49D3",
      "version": "1.0.0",
      "unitType": "page",
      "description": "",
      "reviewerComment": "",
      "status": "New",
      "isHavingSubscription": false,
      "creditMappings": [],
      "created": "2025-05-06T10:55:45.163584",
      "modified": "2025-05-06T10:55:45.163584",
      "createdBy": "Megha ibqa",
      "modifiedBy": "Megha ibqa"
    }
  ]
}

Overview​

Endpoint Details​

URL:​

Method :​

Header​

Query Parameter:​

Response:​

HTTP Status Codes​

Response Body​

With Only appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5​

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, unittype=page​

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, unittype=execution​

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, unittype=conversation​

With appzId=4B7CA9E3-C87E-4B49-ABD7-52AF75AF1AF5, version=1.0.0​