Documentation
ECG (1.0)
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/audit-trails
- https://orgs.ecg-api.com/api/ecg-admins/audit-trails
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/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>'Response
application/json
null
Bodyapplication/jsonrequiredArray []
In the preceding JSON:
The 'op' property indicates the type of operation.
The 'path' property indicates the element to update.
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'
add : Add a property or array element. For existing property: set value.
remove : Remove a property or array element.
replace : Same as remove followed by add at same location.
valuestring or null or number or boolean or object or (Array of strings or numbers or booleans)required
Example: "new_value"
Any of:
- string
- null
- number
- boolean
- object
- Array of strings or numbers or booleans
string
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}
- https://orgs.ecg-api.com/api/ecg-admins/{personId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"value": "new_value",
"path": "/path",
"op": "replace"
}
]'Response
application/json
{ "id": "8f9bf5e3-9af6-4671-ab5b-59ce782760d5", "policies": [ "2dad50cc-0bfe-4766-9c1e-458b972d5504" ], "customPermissions": [ "a6422ed1-8013-4c4b-8f8a-3654606bf80e" ], "activeInfo": { "active": true, "activeStatusChangedAt": "2026-03-04T17:27:05.147Z" }, "person": { "id": "a01c8f0c-95a1-4e94-b6c7-5074f95cd745", "salutation": "1", "firstName": "string", "lastName": "string", "suffix": "string", "emailAddress": "string", "party": { … } } }
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}
- https://orgs.ecg-api.com/api/ecg-admins/{personId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "id": "8f9bf5e3-9af6-4671-ab5b-59ce782760d5", "policies": [ "2dad50cc-0bfe-4766-9c1e-458b972d5504" ], "customPermissions": [ "a6422ed1-8013-4c4b-8f8a-3654606bf80e" ], "activeInfo": { "active": true, "activeStatusChangedAt": "2026-03-04T17:27:05.147Z" }, "person": { "id": "a01c8f0c-95a1-4e94-b6c7-5074f95cd745", "salutation": "1", "firstName": "string", "lastName": "string", "suffix": "string", "emailAddress": "string", "party": { … } } }
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins
- https://orgs.ecg-api.com/api/ecg-admins
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins?order_by=ASC&skip=0&take=10&searchTerm=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
null
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins
- https://orgs.ecg-api.com/api/ecg-admins
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"legacyIdentifier": "8e49d53e-565d-40e8-83a3-27e2b0670581",
"policies": [
"3ef12aeb-aabf-41c5-a128-be620d1f1c91"
],
"person": {
"salutation": 1,
"firstName": "string",
"lastName": "string",
"suffix": "string",
"contactEmailAddress": "string"
},
"account": {
"email": "string@gmail.com",
"password": "string",
"isAutoGenerated": true
},
"addresses": [
{
"addressLine1": "252 Lomas Santa Fe Dr Suite 290",
"addressLine2": "Behind times square garden",
"stateProvinceCode": "AL",
"city": "San Diego",
"postalCode": "92075",
"countryCode": "US",
"regionCode": "US",
"addressType": 1
}
],
"phoneNumbers": [
{
"extension": "string",
"phoneNumber": "string",
"phoneType": 1
}
],
"customPermissions": [
"5e6f0b55-a1bf-4ee5-a2c7-41cd4b023afc"
]
}'Response
application/json
{ "id": "8f9bf5e3-9af6-4671-ab5b-59ce782760d5", "policies": [ "2dad50cc-0bfe-4766-9c1e-458b972d5504" ], "customPermissions": [ "a6422ed1-8013-4c4b-8f8a-3654606bf80e" ], "activeInfo": { "active": true, "activeStatusChangedAt": "2026-03-04T17:27:05.147Z" }, "person": { "id": "a01c8f0c-95a1-4e94-b6c7-5074f95cd745", "salutation": "1", "firstName": "string", "lastName": "string", "suffix": "string", "emailAddress": "string", "party": { … } } }
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}/activate
- https://orgs.ecg-api.com/api/ecg-admins/{personId}/activate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}/activate' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "value": true }
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}/deactivate
- https://orgs.ecg-api.com/api/ecg-admins/{personId}/deactivate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}/deactivate' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "value": true }
- Mock serverhttps://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}/audit-trails
- https://orgs.ecg-api.com/api/ecg-admins/{personId}/audit-trails
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}/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>'Response
application/json
null