Skip to content
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.ecg-api.com/_mock/products/organizations/apis/orgs
https://orgs.ecg-api.com
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Lists available ECG Admin Audit Trails for all the ECG Admins.

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/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>'

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 ECG Admin information by updating the items.

Request

Security
bearer
Path
personIdstringrequired
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/ecg-admins/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "value": "new_value",
      "path": "/path",
      "op": "replace"
    }
  ]'

Responses

Bodyapplication/json
idstringrequired
Example: "8f9bf5e3-9af6-4671-ab5b-59ce782760d5"
policiesArray of stringsrequired
Example: ["2dad50cc-0bfe-4766-9c1e-458b972d5504"]
customPermissionsArray of strings
Example: ["a6422ed1-8013-4c4b-8f8a-3654606bf80e"]
activeInfoobject(ActiveInfoDto)required
activeInfo.​activebooleanrequired
Example: true
activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
personobject(PersonDisplayModel)required
person.​idstringrequired
Example: "a01c8f0c-95a1-4e94-b6c7-5074f95cd745"
person.​salutationnumberrequired
Example: "1"
person.​firstNamestringrequired
Example: "string"
person.​lastNamestringrequired
Example: "string"
person.​suffixstringrequired
Example: "string"
person.​emailAddressstringrequired
Example: "string"
person.​partyobject(PartyDisplayModel)required
person.​party.​idstringrequired
Example: "c182ed73-7b78-4d27-a14b-e30acf7f4104"
person.​party.​legacyIdentifierstringrequired
Example: "string"
person.​party.​archiveInfoobject(ArchiveInfoDto)required
person.​party.​archiveInfo.​archivedboolean
Example: false
person.​party.​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
person.​party.​auditInfoobject(AuditInfoDto)required
person.​party.​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
person.​party.​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
person.​party.​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
person.​party.​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
person.​party.​activeInfoobject(ActiveInfoDto)required
person.​party.​activeInfo.​activebooleanrequired
Example: true
person.​party.​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
person.​party.​phoneNumbersArray of objects(PhoneNumberDisplayModel)required
person.​party.​phoneNumbers[].​idstringrequired
Example: "2674269e-d3b2-4cd0-a693-20953b1818b9"
person.​party.​phoneNumbers[].​phoneTypenumberrequired
Example: "1"
person.​party.​phoneNumbers[].​phoneNumberstringrequired
Example: "string"
person.​party.​phoneNumbers[].​extensionstringrequired
Example: "string"
person.​party.​addressesArray of objects(PartyAddressDisplayModel)required
person.​party.​addresses[].​idstringrequired
Example: "d8036c26-3113-44be-ba4f-f60934b8eab1"
person.​party.​addresses[].​addressTypenumberrequired
Example: 1
person.​party.​addresses[].​addressLine1string
Example: "252 Lomas Santa Fe Dr Suite 290"
person.​party.​addresses[].​addressLine2string
Example: "Behind times square garden"
person.​party.​addresses[].​stateProvinceCodestring
Example: "AL"
person.​party.​addresses[].​stateProvinceNamestring
Example: "Alabama"
person.​party.​addresses[].​citystring
Example: "San Diego"
person.​party.​addresses[].​postalCodestring
Example: "92075"
person.​party.​addresses[].​countryCodestring
Example: "US"
person.​party.​addresses[].​countryNamestring
Example: "United States"
person.​party.​addresses[].​regionCodestring
Enum"US""EU"
person.​party.​addresses[].​regionNamestring
Example: "United States"
person.​party.​addresses[].​auditInfoobject(AuditInfoDto)required
person.​party.​addresses[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
person.​party.​addresses[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
person.​party.​addresses[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
person.​party.​addresses[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
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": { … } } }

Request

Security
bearer
Path
personIdstringrequired
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/ecg-admins/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
Example: "8f9bf5e3-9af6-4671-ab5b-59ce782760d5"
policiesArray of stringsrequired
Example: ["2dad50cc-0bfe-4766-9c1e-458b972d5504"]
customPermissionsArray of strings
Example: ["a6422ed1-8013-4c4b-8f8a-3654606bf80e"]
activeInfoobject(ActiveInfoDto)required
activeInfo.​activebooleanrequired
Example: true
activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
personobject(PersonDisplayModel)required
person.​idstringrequired
Example: "a01c8f0c-95a1-4e94-b6c7-5074f95cd745"
person.​salutationnumberrequired
Example: "1"
person.​firstNamestringrequired
Example: "string"
person.​lastNamestringrequired
Example: "string"
person.​suffixstringrequired
Example: "string"
person.​emailAddressstringrequired
Example: "string"
person.​partyobject(PartyDisplayModel)required
person.​party.​idstringrequired
Example: "c182ed73-7b78-4d27-a14b-e30acf7f4104"
person.​party.​legacyIdentifierstringrequired
Example: "string"
person.​party.​archiveInfoobject(ArchiveInfoDto)required
person.​party.​archiveInfo.​archivedboolean
Example: false
person.​party.​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
person.​party.​auditInfoobject(AuditInfoDto)required
person.​party.​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
person.​party.​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
person.​party.​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
person.​party.​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
person.​party.​activeInfoobject(ActiveInfoDto)required
person.​party.​activeInfo.​activebooleanrequired
Example: true
person.​party.​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
person.​party.​phoneNumbersArray of objects(PhoneNumberDisplayModel)required
person.​party.​phoneNumbers[].​idstringrequired
Example: "2674269e-d3b2-4cd0-a693-20953b1818b9"
person.​party.​phoneNumbers[].​phoneTypenumberrequired
Example: "1"
person.​party.​phoneNumbers[].​phoneNumberstringrequired
Example: "string"
person.​party.​phoneNumbers[].​extensionstringrequired
Example: "string"
person.​party.​addressesArray of objects(PartyAddressDisplayModel)required
person.​party.​addresses[].​idstringrequired
Example: "d8036c26-3113-44be-ba4f-f60934b8eab1"
person.​party.​addresses[].​addressTypenumberrequired
Example: 1
person.​party.​addresses[].​addressLine1string
Example: "252 Lomas Santa Fe Dr Suite 290"
person.​party.​addresses[].​addressLine2string
Example: "Behind times square garden"
person.​party.​addresses[].​stateProvinceCodestring
Example: "AL"
person.​party.​addresses[].​stateProvinceNamestring
Example: "Alabama"
person.​party.​addresses[].​citystring
Example: "San Diego"
person.​party.​addresses[].​postalCodestring
Example: "92075"
person.​party.​addresses[].​countryCodestring
Example: "US"
person.​party.​addresses[].​countryNamestring
Example: "United States"
person.​party.​addresses[].​regionCodestring
Enum"US""EU"
person.​party.​addresses[].​regionNamestring
Example: "United States"
person.​party.​addresses[].​auditInfoobject(AuditInfoDto)required
person.​party.​addresses[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
person.​party.​addresses[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
person.​party.​addresses[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
person.​party.​addresses[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
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": { … } } }

Lists all the available ECG Admin.

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: firstName, lastName, contactEmailAddress or fullName(firstName+lastName).

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>'

Responses

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

Request

Security
bearer
Bodyapplication/jsonrequired
legacyIdentifierstring
Example: "8e49d53e-565d-40e8-83a3-27e2b0670581"
policiesArray of strings
Example: ["3ef12aeb-aabf-41c5-a128-be620d1f1c91"]
personobject(AddPersonDto)required
person.​salutationnumber
Example: 1
person.​firstNamestringrequired
Example: "string"
person.​lastNamestringrequired
Example: "string"
person.​suffixstring
Example: "string"
person.​contactEmailAddressstring
Example: "string"
accountobject(AddAccountDto)
addressesArray of objects(AddAddressDto)required
addresses[].​addressLine1string
Example: "252 Lomas Santa Fe Dr Suite 290"
addresses[].​addressLine2string
Example: "Behind times square garden"
addresses[].​stateProvinceCodestring
Example: "AL"
addresses[].​citystring
Example: "San Diego"
addresses[].​postalCodestring
Example: "92075"
addresses[].​countryCodestring
Example: "US"
addresses[].​regionCodestring
Enum"US""EU"
addresses[].​addressTypenumberrequired
Example: 1
phoneNumbersArray of objects(AddPhoneNumberDto)required
phoneNumbers[].​extensionstring
Example: "string"
phoneNumbers[].​phoneNumberstring
Example: "string"
phoneNumbers[].​phoneTypenumberrequired
Example: 1
customPermissionsArray of strings
Example: ["5e6f0b55-a1bf-4ee5-a2c7-41cd4b023afc"]
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"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
Example: "8f9bf5e3-9af6-4671-ab5b-59ce782760d5"
policiesArray of stringsrequired
Example: ["2dad50cc-0bfe-4766-9c1e-458b972d5504"]
customPermissionsArray of strings
Example: ["a6422ed1-8013-4c4b-8f8a-3654606bf80e"]
activeInfoobject(ActiveInfoDto)required
activeInfo.​activebooleanrequired
Example: true
activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
personobject(PersonDisplayModel)required
person.​idstringrequired
Example: "a01c8f0c-95a1-4e94-b6c7-5074f95cd745"
person.​salutationnumberrequired
Example: "1"
person.​firstNamestringrequired
Example: "string"
person.​lastNamestringrequired
Example: "string"
person.​suffixstringrequired
Example: "string"
person.​emailAddressstringrequired
Example: "string"
person.​partyobject(PartyDisplayModel)required
person.​party.​idstringrequired
Example: "c182ed73-7b78-4d27-a14b-e30acf7f4104"
person.​party.​legacyIdentifierstringrequired
Example: "string"
person.​party.​archiveInfoobject(ArchiveInfoDto)required
person.​party.​archiveInfo.​archivedboolean
Example: false
person.​party.​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
person.​party.​auditInfoobject(AuditInfoDto)required
person.​party.​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
person.​party.​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
person.​party.​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
person.​party.​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
person.​party.​activeInfoobject(ActiveInfoDto)required
person.​party.​activeInfo.​activebooleanrequired
Example: true
person.​party.​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
person.​party.​phoneNumbersArray of objects(PhoneNumberDisplayModel)required
person.​party.​phoneNumbers[].​idstringrequired
Example: "2674269e-d3b2-4cd0-a693-20953b1818b9"
person.​party.​phoneNumbers[].​phoneTypenumberrequired
Example: "1"
person.​party.​phoneNumbers[].​phoneNumberstringrequired
Example: "string"
person.​party.​phoneNumbers[].​extensionstringrequired
Example: "string"
person.​party.​addressesArray of objects(PartyAddressDisplayModel)required
person.​party.​addresses[].​idstringrequired
Example: "d8036c26-3113-44be-ba4f-f60934b8eab1"
person.​party.​addresses[].​addressTypenumberrequired
Example: 1
person.​party.​addresses[].​addressLine1string
Example: "252 Lomas Santa Fe Dr Suite 290"
person.​party.​addresses[].​addressLine2string
Example: "Behind times square garden"
person.​party.​addresses[].​stateProvinceCodestring
Example: "AL"
person.​party.​addresses[].​stateProvinceNamestring
Example: "Alabama"
person.​party.​addresses[].​citystring
Example: "San Diego"
person.​party.​addresses[].​postalCodestring
Example: "92075"
person.​party.​addresses[].​countryCodestring
Example: "US"
person.​party.​addresses[].​countryNamestring
Example: "United States"
person.​party.​addresses[].​regionCodestring
Enum"US""EU"
person.​party.​addresses[].​regionNamestring
Example: "United States"
person.​party.​addresses[].​auditInfoobject(AuditInfoDto)required
person.​party.​addresses[].​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
person.​party.​addresses[].​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
person.​party.​addresses[].​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
person.​party.​addresses[].​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
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": { … } } }

Activate the ECG Admin information.

Request

Security
bearer
Path
personIdstringrequired
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>'

Responses

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

Deactivate the ECG Admin information.

Request

Security
bearer
Path
personIdstringrequired
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>'

Responses

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

Lists all the available ECG Admin Audit Trails for given ECG Admin Id.

Request

Security
bearer
Path
personIdstringrequired
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/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>'

Responses

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

Subscriber Status Change Histories

Operations
Operations
Operations
Operations
Operations
Operations
Operations