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

Anelto Credentials

Operations

Subscriber Devices

Operations

Client Credentials

Operations

Subscriber Status Change Histories

Operations

Partner-Types-V2

Operations

Partner-Organizations

Operations

The purpose of this API is to add a new partner

Request

Permissions needed - organizations.billing.admin (This is for backward compatibility and will be deprecated soon) ,partners.create (This is the required permission to create a partner)

Visit the confluence story for more information - PART | Partner API Specifications
Security
bearer
Query
createApptivoAccountstring
Default "false"
Enum"true""false"
createBillDotComProfilestring
Default "false"
Enum"true""false"
Bodyapplication/jsonrequired
organizationobject(AddOrganizationDto)required
organization.​legacyIdentifierstring
Example: "ae23fba4-f740-4d74-bbd6-80beee24f8f2"
organization.​parentIdstring
Example: "5a1bc4c5-520f-4637-acac-99412fd97509"
organization.​typestring
Enum"1""2"
organization.​hcoXrefIdstring
Example: "string"
organization.​businessNamestringrequired
Example: "string"
organization.​displayNamestringrequired
Example: "string"
organization.​integrationMetadataobject(IntegrationMetadataDto)
organization.​addressesArray of objects(AddAddressDto)
organization.​phoneNumbersArray of objects(AddPhoneNumberDto)
organization.​originationSourcestringrequired
Enum"CRM""ADDI"
organization.​onBoardingStatusnumber

status: 1 indicates "Not Started", status: 2 indicates "Welcome Call", status: 3 indicates "Partner Education", status: 4 indicates "Completed",

Default 1
organization.​organizationStatusnumber

status: 1 indicates "Contracted", status: 2 indicates "Active", status: 3 indicates "Suspended", status: 4 indicates "Separated"

Default 1
organization.​rrmsSiteGroupIdstring
Example: "string"
organization.​signOnDatestring(date-time)
Example: "2026-03-04T17:27:05.253Z"
organization.​timezoneIdstring
Example: "string"
organization.​actionPlanCodestring
Example: "11011"
organization.​vendorProfileIdsArray of strings
Example: ["e596d9f2-0642-4575-897a-8cdb9c18c882"]
organization.​onBoardingPartnerIdstring
Deprecated
Example: "7bfbe222-e8db-4305-86ee-38eddc7df552"
partnerCriteriaobject(AddPartnerCriteriaDto)required
partnerCriteria.​partnerTypeIdstringrequired
Example: "e8d2d255-3e62-413f-9275-e8929eced814"
partnerCriteria.​onboardingDatestring(date-time)

Should be of type - yyyy-MM-dd

Example: "2026-03-04"
partnerCriteria.​enableCommissionsboolean
Default false
partnerCriteria.​w9Submittedboolean
Default false
partnerCriteria.​isW2boolean
Default false
partnerCriteria.​statusstring
Deprecated

field has been deprecated

Default "active"
partnerCriteria.​commissionPayoutStatusstring
Deprecated

field has been deprecated

Default "inactive"
Enum"active""inactive""blocked""pending-cutoff""under-charge-back"
partnerCriteria.​deactivatedDatestring(date-time)
Deprecated

field has been deprecated

Example: "2026-03-04"
partnerCriteria.​salesCutOffDatestring(date-time)
Deprecated

field has been deprecated

Example: "2026-03-04"
vendorAccountobject(AddVendorAccountDto)
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/v2/partners?createApptivoAccount=true&createBillDotComProfile=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organization": {
      "legacyIdentifier": "ae23fba4-f740-4d74-bbd6-80beee24f8f2",
      "parentId": "5a1bc4c5-520f-4637-acac-99412fd97509",
      "type": "1",
      "hcoXrefId": "string",
      "businessName": "string",
      "displayName": "string",
      "integrationMetadata": {
        "key": {
          "key1": "value1",
          "key2": "value2"
        }
      },
      "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
        }
      ],
      "onBoardingPartnerId": "7bfbe222-e8db-4305-86ee-38eddc7df552",
      "originationSource": "CRM",
      "onBoardingStatus": 1,
      "organizationStatus": 1,
      "rrmsSiteGroupId": "string",
      "signOnDate": "2026-03-04T17:27:05.253Z",
      "timezoneId": "string",
      "actionPlanCode": "11011",
      "vendorProfileIds": [
        "e596d9f2-0642-4575-897a-8cdb9c18c882"
      ]
    },
    "partnerCriteria": {
      "partnerTypeId": "e8d2d255-3e62-413f-9275-e8929eced814",
      "status": "active",
      "commissionPayoutStatus": "active",
      "deactivatedDate": "2026-03-04",
      "onboardingDate": "2026-03-04",
      "salesCutOffDate": "2026-03-04",
      "enableCommissions": false,
      "w9Submitted": false,
      "isW2": false
    },
    "vendorAccount": {
      "currency": "USD",
      "accountNumber": "1234567890",
      "email": "email@test.com",
      "bankAccount": {
        "paymentPurpose": {
          "code": {
            "name": "string"
          },
          "text": "OPTIONAL"
        },
        "type": "CHECKING",
        "payeeName": "string",
        "nameOnAccount": "string",
        "accountNumber": "1234567890",
        "routingNumber": "021000021",
        "regulatoryFields": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    }
  }'

Responses

Bodyapplication/json
idstringrequired
Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"
typestringrequired
Example: "string"
statusstring
Example: "string"
hcoXrefIdstring
Example: "string"
businessNamestringrequired
Example: "string"
displayNamestringrequired
Example: "string"
integrationMetadataobject
Example: {"key":"value"}
nodesArray of stringsrequired
Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]
ancestryNodesArray of stringsrequired
Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]
originationSourcestringrequired
Example: "string"
onBoardingStatusnumberrequired
Example: 1
organizationStatusnumberrequired
Example: 1
rrmsSiteGroupIdstring
Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"
timezoneIdstring
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"
activeInfoobject(ActiveInfoDto)required
activeInfo.​activebooleanrequired
Example: true
activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
partyobject(PartyDisplayModel)
signOnDatestring(date-time)
Example: "2026-03-04T17:27:05.269Z"
actionPlanCodestring
Example: "string"
customerIdstring
Example: "string"
partnerCriteriaobject(PartnerCriteriaDisplayModel)
vendorProfilesVendorProfilePreviewModel (object) or string
One of:
onBoardingPartnerOrganizationChildDisplayModel (object) or string
One of:
parentPartnerOrganizationChildDisplayModel (object) or string
One of:
subsidiariesArray of objects(OrganizationChildDisplayModel)

Child Partners Details

Response
application/json
{
  "id": "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9",
  "type": "string",
  "status": "string",
  "hcoXrefId": "string",
  "businessName": "string",
  "displayName": "string",
  "integrationMetadata": {
    "key": "value"
  },
  "nodes": [
    "a60dbf9d-2963-4256-9019-94296a81cb1c"
  ],
  "ancestryNodes": [
    "289fe665-e0aa-4eab-9440-cdbfbd9afdee"
  ],
  "originationSource": "string",
  "onBoardingStatus": 1,
  "organizationStatus": 1,
  "rrmsSiteGroupId": "974ad49c-2a0c-4a88-b25a-5852047b3407",
  "timezoneId": "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"
  },
  "activeInfo": {
    "active": true,
    "activeStatusChangedAt": "2026-03-04T17:27:05.147Z"
  },
  "party": {
    "id": "c182ed73-7b78-4d27-a14b-e30acf7f4104",
    "legacyIdentifier": "string",
    "archiveInfo": { … },
    "auditInfo": { … },
    "activeInfo": { … },
    "phoneNumbers": [ … ],
    "addresses": [ … ]
  },
  "signOnDate": "2026-03-04T17:27:05.269Z",
  "actionPlanCode": "string",
  "customerId": "string",
  "partnerCriteria": {
    "id": "2faa49d6-1f60-452b-a6b8-a8b3acb8f384",
    "partnerType": { … },
    "status": "on-boarded",
    "commissionPayoutStatus": "active",
    "deactivatedDate": "2026-03-04T17:27:05.268Z",
    "onboardingDate": "2026-03-04T17:27:05.268Z",
    "salesCutOffDate": "2026-03-04T17:27:05.268Z",
    "enableCommissions": false,
    "w9Submitted": false,
    "isW2": false,
    "vendorMetadata": { … }
  },
  "vendorProfiles": {
    "id": "884b7b3f-1cc2-44e9-8ae9-62c8a966916e",
    "name": "string",
    "source": "anelto",
    "description": "string",
    "auditInfo": { … },
    "activeInfo": { … }
  },
  "onBoardingPartner": {
    "id": "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9",
    "type": "string",
    "status": "string",
    "hcoXrefId": "string",
    "businessName": "string",
    "displayName": "string",
    "integrationMetadata": { … },
    "nodes": [ … ],
    "ancestryNodes": [ … ],
    "originationSource": "string",
    "onBoardingStatus": 1,
    "organizationStatus": 1,
    "rrmsSiteGroupId": "974ad49c-2a0c-4a88-b25a-5852047b3407",
    "timezoneId": "string",
    "archiveInfo": { … },
    "auditInfo": { … },
    "activeInfo": { … },
    "party": { … },
    "signOnDate": "2026-03-04T17:27:05.269Z",
    "actionPlanCode": "string",
    "customerId": "string",
    "partnerCriteria": { … },
    "vendorProfiles": { … }
  },
  "parentPartner": {
    "id": "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9",
    "type": "string",
    "status": "string",
    "hcoXrefId": "string",
    "businessName": "string",
    "displayName": "string",
    "integrationMetadata": { … },
    "nodes": [ … ],
    "ancestryNodes": [ … ],
    "originationSource": "string",
    "onBoardingStatus": 1,
    "organizationStatus": 1,
    "rrmsSiteGroupId": "974ad49c-2a0c-4a88-b25a-5852047b3407",
    "timezoneId": "string",
    "archiveInfo": { … },
    "auditInfo": { … },
    "activeInfo": { … },
    "party": { … },
    "signOnDate": "2026-03-04T17:27:05.269Z",
    "actionPlanCode": "string",
    "customerId": "string",
    "partnerCriteria": { … },
    "vendorProfiles": { … }
  },
  "subsidiaries": [
    { … }
  ]
}

This API will list all the given partners.

Request

Permissions needed - partners.read

Visit the confluence story for more information - PART | Partner API Specifications
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
includeArray of strings
Items Enum"parent-partner""parent-partner-criteria""subsidiaries""partner-type""on-boarding-partner"
statusArray of strings

Default Value: [Active,Inactive,Suspended,Restored]

Items Enum"Active""Inactive""Suspended""Archived""Restored"
partnerStatusArray of strings
Items Enum"on-boarded""active""inactive""suspended""on-hold"
commissionPayoutStatusArray of strings
Items Enum"active""inactive""blocked""pending-cutoff""under-charge-back"
searchTermstring

Search By : Partner Organization displayName or businessName

partnerTypeIdsArray of strings

To filter by partnerTypeIds, make sure to include include=partner-type in the query parameters.

partnerIdsArray of strings

By adding the 'partnerIds' parameter to the API call, you can retrieve a list of partner information based on the specified IDs.

w9Submittedboolean

Filter partners by W-9 submission status

enableCommissionsboolean

Filter partners by commissions enabled status

isW2boolean

Filter partners by isW2 submission status

curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/v2/partners?order_by=ASC&skip=0&take=10&include=parent-partner&status=Active&partnerStatus=on-boarded&commissionPayoutStatus=active&searchTerm=string&partnerTypeIds=string&partnerIds=string&w9Submitted=true&enableCommissions=true&isW2=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

This API will get the partner details

Request

Permissions needed - partners.read

Visit the confluence story for more information - PART | Partner API Specifications
Security
bearer
Path
partnerIdstringrequired
Example: string
Query
includeArray of strings
Items Enum"parent-partner""parent-partner-criteria""subsidiaries""partner-type""on-boarding-partner"
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/api/v2/partners/string?include=parent-partner' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"
typestringrequired
Example: "string"
statusstring
Example: "string"
hcoXrefIdstring
Example: "string"
businessNamestringrequired
Example: "string"
displayNamestringrequired
Example: "string"
integrationMetadataobject
Example: {"key":"value"}
nodesArray of stringsrequired
Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]
ancestryNodesArray of stringsrequired
Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]
originationSourcestringrequired
Example: "string"
onBoardingStatusnumberrequired
Example: 1
organizationStatusnumberrequired
Example: 1
rrmsSiteGroupIdstring
Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"
timezoneIdstring
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"
activeInfoobject(ActiveInfoDto)required
activeInfo.​activebooleanrequired
Example: true
activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
partyobject(PartyDisplayModel)
signOnDatestring(date-time)
Example: "2026-03-04T17:27:05.269Z"
actionPlanCodestring
Example: "string"
customerIdstring
Example: "string"
partnerCriteriaobject(PartnerCriteriaDisplayModel)
vendorProfilesVendorProfilePreviewModel (object) or string
One of:
onBoardingPartnerOrganizationChildDisplayModel (object) or string
One of:
parentPartnerOrganizationChildDisplayModel (object) or string
One of:
subsidiariesArray of objects(OrganizationChildDisplayModel)

Child Partners Details

Response
application/json
{
  "id": "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9",
  "type": "string",
  "status": "string",
  "hcoXrefId": "string",
  "businessName": "string",
  "displayName": "string",
  "integrationMetadata": {
    "key": "value"
  },
  "nodes": [
    "a60dbf9d-2963-4256-9019-94296a81cb1c"
  ],
  "ancestryNodes": [
    "289fe665-e0aa-4eab-9440-cdbfbd9afdee"
  ],
  "originationSource": "string",
  "onBoardingStatus": 1,
  "organizationStatus": 1,
  "rrmsSiteGroupId": "974ad49c-2a0c-4a88-b25a-5852047b3407",
  "timezoneId": "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"
  },
  "activeInfo": {
    "active": true,
    "activeStatusChangedAt": "2026-03-04T17:27:05.147Z"
  },
  "party": {
    "id": "c182ed73-7b78-4d27-a14b-e30acf7f4104",
    "legacyIdentifier": "string",
    "archiveInfo": { … },
    "auditInfo": { … },
    "activeInfo": { … },
    "phoneNumbers": [ … ],
    "addresses": [ … ]
  },
  "signOnDate": "2026-03-04T17:27:05.269Z",
  "actionPlanCode": "string",
  "customerId": "string",
  "partnerCriteria": {
    "id": "2faa49d6-1f60-452b-a6b8-a8b3acb8f384",
    "partnerType": { … },
    "status": "on-boarded",
    "commissionPayoutStatus": "active",
    "deactivatedDate": "2026-03-04T17:27:05.268Z",
    "onboardingDate": "2026-03-04T17:27:05.268Z",
    "salesCutOffDate": "2026-03-04T17:27:05.268Z",
    "enableCommissions": false,
    "w9Submitted": false,
    "isW2": false,
    "vendorMetadata": { … }
  },
  "vendorProfiles": {
    "id": "884b7b3f-1cc2-44e9-8ae9-62c8a966916e",
    "name": "string",
    "source": "anelto",
    "description": "string",
    "auditInfo": { … },
    "activeInfo": { … }
  },
  "onBoardingPartner": {
    "id": "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9",
    "type": "string",
    "status": "string",
    "hcoXrefId": "string",
    "businessName": "string",
    "displayName": "string",
    "integrationMetadata": { … },
    "nodes": [ … ],
    "ancestryNodes": [ … ],
    "originationSource": "string",
    "onBoardingStatus": 1,
    "organizationStatus": 1,
    "rrmsSiteGroupId": "974ad49c-2a0c-4a88-b25a-5852047b3407",
    "timezoneId": "string",
    "archiveInfo": { … },
    "auditInfo": { … },
    "activeInfo": { … },
    "party": { … },
    "signOnDate": "2026-03-04T17:27:05.269Z",
    "actionPlanCode": "string",
    "customerId": "string",
    "partnerCriteria": { … },
    "vendorProfiles": { … }
  },
  "parentPartner": {
    "id": "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9",
    "type": "string",
    "status": "string",
    "hcoXrefId": "string",
    "businessName": "string",
    "displayName": "string",
    "integrationMetadata": { … },
    "nodes": [ … ],
    "ancestryNodes": [ … ],
    "originationSource": "string",
    "onBoardingStatus": 1,
    "organizationStatus": 1,
    "rrmsSiteGroupId": "974ad49c-2a0c-4a88-b25a-5852047b3407",
    "timezoneId": "string",
    "archiveInfo": { … },
    "auditInfo": { … },
    "activeInfo": { … },
    "party": { … },
    "signOnDate": "2026-03-04T17:27:05.269Z",
    "actionPlanCode": "string",
    "customerId": "string",
    "partnerCriteria": { … },
    "vendorProfiles": { … }
  },
  "subsidiaries": [
    { … }
  ]
}

Bill-Vendors

Operations

Partner-Activities

Operations

Teams

Operations

Vendor Profiles

Operations