Skip to content

ECG (1.0)

Documentation

Download OpenAPI description
orgs.json
orgs.yaml
Overview
Languages
Servers
Mock server
https://docs.ecg-api.com/_mock/products/organizations/apis/orgs
https://orgs.ecg-api.com

Health

Operations

Applications

Operations

Modules

Operations

Permissions

Operations

Policies

Operations

PermissionCaches

Operations

Organizations

Operations

SeedData

Operations

Statistics

Operations

Organizations-Type

Operations

ApptivoPayloads

Operations

Users

Operations

People

Operations

Staff-Members

Operations

Organization Transfer

Operations

Subscribers

Operations

Subscribers Profile

Operations

Subscriber Transfer

Operations

Batch Subscriber Transfers

Operations

EcgAdmins

Operations

Partners (Deprecated)

Operations

PartnerTypes (Deprecated)

Operations

SuccessLadderBonuses (Deprecated)

Operations

PolicyGroups

Operations

Lists available Policy Group Audit Trails for all the Policy Groups.

Request

Security
bearer
Query
order_bystring
Enum"ASC""DESC"
Example: order_by=ASC
skipnumber

Number of Pages to skip, Default value : 0

Default 0
takenumber

Number of Records per page, Default value : 10

Default 10
sort_bystring

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTermstring

Search By: action

Enum"UPDATE""DELETE""INSERT"
dateRangeTypestring
Enum"custom""this-year""last-year""today""this-week""last-week""this-month""last-month""this-quarter""last-quarter"
fromstring(date-time)
Example: from=2026-03-04T17:27:05.470Z
tostring(date-time)
Example: to=2026-03-04T17:27:05.470Z
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/audit-trails?order_by=ASC&skip=0&take=10&sort_by=modifiedAt&searchTerm=UPDATE&dateRangeType=custom&from=2026-03-04T17%3A27%3A05.470Z&to=2026-03-04T17%3A27%3A05.470Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects(AuditTrailDisplayModel)
currentPageNumbernumber
Example: 0
recordsPerPagenumber
Example: 0
totalRecordsnumber
Example: 0
totalPagesnumber
Example: 0
Response
application/json
null

Patches the Policy Group information by updating the items.

Request

Security
bearer
Path
policyGroupIdstringrequired
Bodyapplication/jsonrequired

In the preceding JSON:

  1. The 'op' property indicates the type of operation.

  2. The 'path' property indicates the element to update.

  3. The 'value' property provides the new value. - The TYPE of 'value' depends on the TYPE of the element in 'path'

For Example: If TYPE of element in path: '/isProvider' is 'boolean' , then The TYPE of Value should be 'boolean'

op can be 'add' , 'replace' or 'remove'

  1. add : Add a property or array element. For existing property: set value.

  2. remove : Remove a property or array element.

  3. replace : Same as remove followed by add at same location.

Array [
valuestring or null or number or boolean or object or (Array of strings or numbers or booleans)required
Example: "new_value"
Any of:
string
pathstringrequired
Example: "/path"
opstringrequired
Enum"replace""add""remove"
Example: "replace"
]
curl -i -X PATCH \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "value": "new_value",
      "path": "/path",
      "op": "replace"
    }
  ]'

Responses

Bodyapplication/json
idstringrequired
Example: "978dd95c-bedc-423f-8fec-6f1d8ff2041d"
titlestringrequired
Example: "string"
codestringrequired
Example: "string"
descriptionstringrequired
Example: "string"
archiveInfoobject(ArchiveInfoDto)required
archiveInfo.​archivedboolean
Example: false
archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
auditInfoobject(AuditInfoDto)required
auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policiesArray of objects(PolicyDisplayModel)required
policies[].​idstringrequired
Example: "e160a352-6a2b-4e25-9d63-b1183e1ad29b"
policies[].​namestringrequired
Example: "string"
policies[].​codestringrequired
Example: "string"
policies[].​descriptionstringrequired
Example: "string"
policies[].​IsInUsebooleanrequired
Example: false
policies[].​internalUseOnlyboolean
Example: false
policies[].​archiveInfoobject(ArchiveInfoDto)required
policies[].​archiveInfo.​archivedboolean
Example: false
policies[].​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
policies[].​auditInfoobject(AuditInfoDto)required
policies[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
policies[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
policies[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
policies[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policies[].​activeInfoobject(ActiveInfoDto)required
policies[].​activeInfo.​activebooleanrequired
Example: true
policies[].​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
policies[].​organizationobject(OrganizationDisplayModel)
policies[].​permissionsArray of objects(PermissionDisplayModel)
Response
application/json
{
  "id": "978dd95c-bedc-423f-8fec-6f1d8ff2041d",
  "title": "string",
  "code": "string",
  "description": "string",
  "archiveInfo": {
    "archived": false,
    "archivedStatusChangedAt": "2026-03-04T17:27:05.147Z"
  },
  "auditInfo": {
    "createdAt": "2026-03-04T17:27:05.145Z",
    "createdBy": "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd",
    "updatedAt": "2026-03-04T17:27:05.146Z",
    "updatedBy": "1372b691-af02-4b90-945a-c6351e785879"
  },
  "policies": [
    { … }
  ]
}

Get the Policy Group by Id.

Request

Security
bearer
Path
policyGroupIdstringrequired
Query
includestring

For query include=policies it returns policy-group with policies

Value"policies"
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}?include=policies' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
Example: "978dd95c-bedc-423f-8fec-6f1d8ff2041d"
titlestringrequired
Example: "string"
codestringrequired
Example: "string"
descriptionstringrequired
Example: "string"
archiveInfoobject(ArchiveInfoDto)required
archiveInfo.​archivedboolean
Example: false
archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
auditInfoobject(AuditInfoDto)required
auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policiesArray of objects(PolicyDisplayModel)required
policies[].​idstringrequired
Example: "e160a352-6a2b-4e25-9d63-b1183e1ad29b"
policies[].​namestringrequired
Example: "string"
policies[].​codestringrequired
Example: "string"
policies[].​descriptionstringrequired
Example: "string"
policies[].​IsInUsebooleanrequired
Example: false
policies[].​internalUseOnlyboolean
Example: false
policies[].​archiveInfoobject(ArchiveInfoDto)required
policies[].​archiveInfo.​archivedboolean
Example: false
policies[].​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
policies[].​auditInfoobject(AuditInfoDto)required
policies[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
policies[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
policies[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
policies[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policies[].​activeInfoobject(ActiveInfoDto)required
policies[].​activeInfo.​activebooleanrequired
Example: true
policies[].​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
policies[].​organizationobject(OrganizationDisplayModel)
policies[].​permissionsArray of objects(PermissionDisplayModel)
Response
application/json
{
  "id": "978dd95c-bedc-423f-8fec-6f1d8ff2041d",
  "title": "string",
  "code": "string",
  "description": "string",
  "archiveInfo": {
    "archived": false,
    "archivedStatusChangedAt": "2026-03-04T17:27:05.147Z"
  },
  "auditInfo": {
    "createdAt": "2026-03-04T17:27:05.145Z",
    "createdBy": "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd",
    "updatedAt": "2026-03-04T17:27:05.146Z",
    "updatedBy": "1372b691-af02-4b90-945a-c6351e785879"
  },
  "policies": [
    { … }
  ]
}

Deletes the Policy Group information.

Request

Security
bearer
Path
policyGroupIdstringrequired
curl -i -X DELETE \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
valuebooleanrequired
Example: true
Response
application/json
{
  "value": true
}

Lists all the available Policy Group.

Request

Security
bearer
Query
order_bystring
Enum"ASC""DESC"
Example: order_by=ASC
skipnumber

Number of Pages to skip, Default value : 0

Default 0
takenumber

Number of Records per page, Default value : 10

Default 10
searchTermstring

Search By: title, code or description

includestring

For query include=policies it returns policy-group with policies

Value"policies"
sort_bystring

Default value : id

Example: sort_by=id
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups?order_by=ASC&skip=0&take=10&searchTerm=string&include=policies&sort_by=id' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects(PolicyGroupDisplayModel)
currentPageNumbernumber
Example: 0
recordsPerPagenumber
Example: 0
totalRecordsnumber
Example: 0
totalPagesnumber
Example: 0
Response
application/json
null

Adds the Policy Group.

Request

Security
bearer
Bodyapplication/jsonrequired
titlestringrequired
Example: "string"
codestringrequired
Example: "string"
descriptionstring
Example: "string | null"
policiesArray of stringsrequired
Example: ["61fa8c2b-9d1e-4b25-978a-bf5a2134b58d"]
curl -i -X POST \
  https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "code": "string",
    "description": "string | null",
    "policies": [
      "61fa8c2b-9d1e-4b25-978a-bf5a2134b58d"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
Example: "978dd95c-bedc-423f-8fec-6f1d8ff2041d"
titlestringrequired
Example: "string"
codestringrequired
Example: "string"
descriptionstringrequired
Example: "string"
archiveInfoobject(ArchiveInfoDto)required
archiveInfo.​archivedboolean
Example: false
archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
auditInfoobject(AuditInfoDto)required
auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policiesArray of objects(PolicyDisplayModel)required
policies[].​idstringrequired
Example: "e160a352-6a2b-4e25-9d63-b1183e1ad29b"
policies[].​namestringrequired
Example: "string"
policies[].​codestringrequired
Example: "string"
policies[].​descriptionstringrequired
Example: "string"
policies[].​IsInUsebooleanrequired
Example: false
policies[].​internalUseOnlyboolean
Example: false
policies[].​archiveInfoobject(ArchiveInfoDto)required
policies[].​archiveInfo.​archivedboolean
Example: false
policies[].​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
policies[].​auditInfoobject(AuditInfoDto)required
policies[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
policies[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
policies[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
policies[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policies[].​activeInfoobject(ActiveInfoDto)required
policies[].​activeInfo.​activebooleanrequired
Example: true
policies[].​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
policies[].​organizationobject(OrganizationDisplayModel)
policies[].​permissionsArray of objects(PermissionDisplayModel)
Response
application/json
{
  "id": "978dd95c-bedc-423f-8fec-6f1d8ff2041d",
  "title": "string",
  "code": "string",
  "description": "string",
  "archiveInfo": {
    "archived": false,
    "archivedStatusChangedAt": "2026-03-04T17:27:05.147Z"
  },
  "auditInfo": {
    "createdAt": "2026-03-04T17:27:05.145Z",
    "createdBy": "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd",
    "updatedAt": "2026-03-04T17:27:05.146Z",
    "updatedBy": "1372b691-af02-4b90-945a-c6351e785879"
  },
  "policies": [
    { … }
  ]
}

Deletes Policies from Policy Group.

Request

Security
bearer
Path
policyGroupIdstringrequired
Bodyapplication/jsonrequired
policyIdsArray of stringsrequired
Example: ["1e366e0e-f95c-4a1e-a8ba-093155d50a7d"]
curl -i -X DELETE \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}/policies' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "policyIds": [
      "1e366e0e-f95c-4a1e-a8ba-093155d50a7d"
    ]
  }'

Responses

Bodyapplication/json
valuebooleanrequired
Example: true
Response
application/json
{
  "value": true
}

Adds Policies to Policy Group.

Request

Security
bearer
Path
policyGroupIdstringrequired
Bodyapplication/jsonrequired
policyIdsArray of stringsrequired
Example: ["1e366e0e-f95c-4a1e-a8ba-093155d50a7d"]
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}/policies' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "policyIds": [
      "1e366e0e-f95c-4a1e-a8ba-093155d50a7d"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
Example: "978dd95c-bedc-423f-8fec-6f1d8ff2041d"
titlestringrequired
Example: "string"
codestringrequired
Example: "string"
descriptionstringrequired
Example: "string"
archiveInfoobject(ArchiveInfoDto)required
archiveInfo.​archivedboolean
Example: false
archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
auditInfoobject(AuditInfoDto)required
auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policiesArray of objects(PolicyDisplayModel)required
policies[].​idstringrequired
Example: "e160a352-6a2b-4e25-9d63-b1183e1ad29b"
policies[].​namestringrequired
Example: "string"
policies[].​codestringrequired
Example: "string"
policies[].​descriptionstringrequired
Example: "string"
policies[].​IsInUsebooleanrequired
Example: false
policies[].​internalUseOnlyboolean
Example: false
policies[].​archiveInfoobject(ArchiveInfoDto)required
policies[].​archiveInfo.​archivedboolean
Example: false
policies[].​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
policies[].​auditInfoobject(AuditInfoDto)required
policies[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
policies[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
policies[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
policies[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
policies[].​activeInfoobject(ActiveInfoDto)required
policies[].​activeInfo.​activebooleanrequired
Example: true
policies[].​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
policies[].​organizationobject(OrganizationDisplayModel)
policies[].​permissionsArray of objects(PermissionDisplayModel)
Response
application/json
{
  "id": "978dd95c-bedc-423f-8fec-6f1d8ff2041d",
  "title": "string",
  "code": "string",
  "description": "string",
  "archiveInfo": {
    "archived": false,
    "archivedStatusChangedAt": "2026-03-04T17:27:05.147Z"
  },
  "auditInfo": {
    "createdAt": "2026-03-04T17:27:05.145Z",
    "createdBy": "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd",
    "updatedAt": "2026-03-04T17:27:05.146Z",
    "updatedBy": "1372b691-af02-4b90-945a-c6351e785879"
  },
  "policies": [
    { … }
  ]
}

Archives the Policy Group information.

Request

Security
bearer
Path
policyGroupIdstringrequired
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
valuebooleanrequired
Example: true
Response
application/json
{
  "value": true
}

Restores the Policy Group information.

Request

Security
bearer
Path
policyGroupIdstringrequired
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
valuebooleanrequired
Example: true
Response
application/json
{
  "value": true
}

Lists all the available Policy Group Audit Trails for given Policy Group Id.

Request

Security
bearer
Path
policyGroupIdstringrequired
Query
order_bystring
Enum"ASC""DESC"
Example: order_by=ASC
skipnumber

Number of Pages to skip, Default value : 0

Default 0
takenumber

Number of Records per page, Default value : 10

Default 10
sort_bystring

Default value : modifiedAt

Example: sort_by=modifiedAt
searchTermstring

Search By: action

Enum"UPDATE""DELETE""INSERT"
dateRangeTypestring
Enum"custom""this-year""last-year""today""this-week""last-week""this-month""last-month""this-quarter""last-quarter"
fromstring(date-time)
Example: from=2026-03-04T17:27:05.470Z
tostring(date-time)
Example: to=2026-03-04T17:27:05.470Z
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/policy-groups/{policyGroupId}/audit-trails?order_by=ASC&skip=0&take=10&sort_by=modifiedAt&searchTerm=UPDATE&dateRangeType=custom&from=2026-03-04T17%3A27%3A05.470Z&to=2026-03-04T17%3A27%3A05.470Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects(AuditTrailDisplayModel)
currentPageNumbernumber
Example: 0
recordsPerPagenumber
Example: 0
totalRecordsnumber
Example: 0
totalPagesnumber
Example: 0
Response
application/json
null

Anelto Credentials

Operations

Subscriber Devices

Operations

Client Credentials

Operations

Subscriber Status Change Histories

Operations

Partner-Types-V2

Operations

Partner-Organizations

Operations

Bill-Vendors

Operations

Partner-Activities

Operations

Teams

Operations

Vendor Profiles

Operations