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

Bill-Vendors

Operations

Partner-Activities

Operations

Teams

Operations

Create a team.

Request

Security
bearer
Path
organizationIdstringrequired
Bodyapplication/jsonrequired
namestringrequired
Example: "Nursing Staff"
descriptionstring
Example: "Handles patient care"
colorstring
Example: "#FF5733"
iconstring
Example: "stethoscope"
typestringrequired
Enum"department""general"
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Nursing Staff",
    "description": "Handles patient care",
    "color": "#FF5733",
    "icon": "stethoscope",
    "type": "department"
  }'

Responses

Bodyapplication/json
namestringrequired
Example: "Nursing Staff"
descriptionstring
Example: "Handles patient care"
colorstring
Example: "#FF5733"
iconstring
Example: "stethoscope"
typestringrequired
Enum"department""general"
idstringrequired
Example: "05429248-9b06-4d8f-adde-464a41b79beb"
codestringrequired
Example: "nursing_staff"
organizationobject(OrganizationDisplayModel)required
organization.​idstringrequired
Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"
organization.​typestringrequired
Example: "string"
organization.​statusstring
Example: "string"
organization.​hcoXrefIdstring
Example: "string"
organization.​businessNamestringrequired
Example: "string"
organization.​displayNamestringrequired
Example: "string"
organization.​integrationMetadataobject
Example: {"key":"value"}
organization.​nodesArray of stringsrequired
Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]
organization.​ancestryNodesArray of stringsrequired
Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]
organization.​originationSourcestringrequired
Example: "string"
organization.​onBoardingStatusnumberrequired
Example: 1
organization.​organizationStatusnumberrequired
Example: 1
organization.​rrmsSiteGroupIdstring
Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"
organization.​timezoneIdstring
Example: "string"
organization.​archiveInfoobject(ArchiveInfoDto)required
organization.​archiveInfo.​archivedboolean
Example: false
organization.​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
organization.​auditInfoobject(AuditInfoDto)required
organization.​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
organization.​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
organization.​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
organization.​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
organization.​activeInfoobject(ActiveInfoDto)required
organization.​activeInfo.​activebooleanrequired
Example: true
organization.​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
organization.​partyobject(PartyDisplayModel)
organization.​signOnDatestring(date-time)
Example: "2026-03-04T17:27:05.269Z"
organization.​actionPlanCodestring
Example: "string"
organization.​customerIdstring
Example: "string"
organization.​partnerCriteriaobject(PartnerCriteriaDisplayModel)
organization.​vendorProfilesVendorProfilePreviewModel (object) or string
One of:
organization.​parentOrganizationobject(OrganizationChildDisplayModel)
organization.​childOrganizationsArray of objects(OrganizationChildDisplayModel)
organization.​onBoardingPartnerstring
Deprecated
Example: "a9c5be63-caa4-4e84-8ef1-505e8298f36e"
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"
Response
application/json
{
  "name": "Nursing Staff",
  "description": "Handles patient care",
  "color": "#FF5733",
  "icon": "stethoscope",
  "type": "department",
  "id": "05429248-9b06-4d8f-adde-464a41b79beb",
  "code": "nursing_staff",
  "organization": {
    "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": { … },
    "parentOrganization": { … },
    "onBoardingPartner": "a9c5be63-caa4-4e84-8ef1-505e8298f36e",
    "childOrganizations": [ … ]
  },
  "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"
  }
}

List all teams in an organization.

Request

Security
bearer
Path
organizationIdstringrequired
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 "createdAt"
Enum"name""createdAt""updatedAt"
Example: sort_by=createdAt
include_parentsboolean
Default false
Example: include_parents=false
statusArray of strings
Items Enum"active""inactive"
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams?order_by=ASC&skip=0&take=10&sort_by=createdAt&include_parents=false&status=active' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Update a team.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
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/organizations/{organizationId}/teams/{teamId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "value": "new_value",
      "path": "/path",
      "op": "replace"
    }
  ]'

Responses

Bodyapplication/json
namestringrequired
Example: "Nursing Staff"
descriptionstring
Example: "Handles patient care"
colorstring
Example: "#FF5733"
iconstring
Example: "stethoscope"
typestringrequired
Enum"department""general"
idstringrequired
Example: "05429248-9b06-4d8f-adde-464a41b79beb"
codestringrequired
Example: "nursing_staff"
organizationobject(OrganizationDisplayModel)required
organization.​idstringrequired
Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"
organization.​typestringrequired
Example: "string"
organization.​statusstring
Example: "string"
organization.​hcoXrefIdstring
Example: "string"
organization.​businessNamestringrequired
Example: "string"
organization.​displayNamestringrequired
Example: "string"
organization.​integrationMetadataobject
Example: {"key":"value"}
organization.​nodesArray of stringsrequired
Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]
organization.​ancestryNodesArray of stringsrequired
Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]
organization.​originationSourcestringrequired
Example: "string"
organization.​onBoardingStatusnumberrequired
Example: 1
organization.​organizationStatusnumberrequired
Example: 1
organization.​rrmsSiteGroupIdstring
Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"
organization.​timezoneIdstring
Example: "string"
organization.​archiveInfoobject(ArchiveInfoDto)required
organization.​archiveInfo.​archivedboolean
Example: false
organization.​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
organization.​auditInfoobject(AuditInfoDto)required
organization.​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
organization.​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
organization.​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
organization.​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
organization.​activeInfoobject(ActiveInfoDto)required
organization.​activeInfo.​activebooleanrequired
Example: true
organization.​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
organization.​partyobject(PartyDisplayModel)
organization.​signOnDatestring(date-time)
Example: "2026-03-04T17:27:05.269Z"
organization.​actionPlanCodestring
Example: "string"
organization.​customerIdstring
Example: "string"
organization.​partnerCriteriaobject(PartnerCriteriaDisplayModel)
organization.​vendorProfilesVendorProfilePreviewModel (object) or string
One of:
organization.​parentOrganizationobject(OrganizationChildDisplayModel)
organization.​childOrganizationsArray of objects(OrganizationChildDisplayModel)
organization.​onBoardingPartnerstring
Deprecated
Example: "a9c5be63-caa4-4e84-8ef1-505e8298f36e"
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"
Response
application/json
{
  "name": "Nursing Staff",
  "description": "Handles patient care",
  "color": "#FF5733",
  "icon": "stethoscope",
  "type": "department",
  "id": "05429248-9b06-4d8f-adde-464a41b79beb",
  "code": "nursing_staff",
  "organization": {
    "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": { … },
    "parentOrganization": { … },
    "onBoardingPartner": "a9c5be63-caa4-4e84-8ef1-505e8298f36e",
    "childOrganizations": [ … ]
  },
  "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"
  }
}

Get the team details.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
namestringrequired
Example: "Nursing Staff"
descriptionstring
Example: "Handles patient care"
colorstring
Example: "#FF5733"
iconstring
Example: "stethoscope"
typestringrequired
Enum"department""general"
idstringrequired
Example: "05429248-9b06-4d8f-adde-464a41b79beb"
codestringrequired
Example: "nursing_staff"
organizationobject(OrganizationDisplayModel)required
organization.​idstringrequired
Example: "854e27cb-7ddd-4c0f-950d-1d60bc9e0cb9"
organization.​typestringrequired
Example: "string"
organization.​statusstring
Example: "string"
organization.​hcoXrefIdstring
Example: "string"
organization.​businessNamestringrequired
Example: "string"
organization.​displayNamestringrequired
Example: "string"
organization.​integrationMetadataobject
Example: {"key":"value"}
organization.​nodesArray of stringsrequired
Example: ["a60dbf9d-2963-4256-9019-94296a81cb1c"]
organization.​ancestryNodesArray of stringsrequired
Example: ["289fe665-e0aa-4eab-9440-cdbfbd9afdee"]
organization.​originationSourcestringrequired
Example: "string"
organization.​onBoardingStatusnumberrequired
Example: 1
organization.​organizationStatusnumberrequired
Example: 1
organization.​rrmsSiteGroupIdstring
Example: "974ad49c-2a0c-4a88-b25a-5852047b3407"
organization.​timezoneIdstring
Example: "string"
organization.​archiveInfoobject(ArchiveInfoDto)required
organization.​archiveInfo.​archivedboolean
Example: false
organization.​archiveInfo.​archivedStatusChangedAtstring(date-time)
Example: "2026-03-04T17:27:05.147Z"
organization.​auditInfoobject(AuditInfoDto)required
organization.​auditInfo.​createdAtstring(date-time)
Example: "2026-03-04T17:27:05.145Z"
organization.​auditInfo.​createdBystring
Example: "a36ac2c8-1a00-4cf0-9f8c-981dc1ffd4cd"
organization.​auditInfo.​updatedAtstring(date-time)
Example: "2026-03-04T17:27:05.146Z"
organization.​auditInfo.​updatedBystring
Example: "1372b691-af02-4b90-945a-c6351e785879"
organization.​activeInfoobject(ActiveInfoDto)required
organization.​activeInfo.​activebooleanrequired
Example: true
organization.​activeInfo.​activeStatusChangedAtstring(date-time)required
Example: "2026-03-04T17:27:05.147Z"
organization.​partyobject(PartyDisplayModel)
organization.​signOnDatestring(date-time)
Example: "2026-03-04T17:27:05.269Z"
organization.​actionPlanCodestring
Example: "string"
organization.​customerIdstring
Example: "string"
organization.​partnerCriteriaobject(PartnerCriteriaDisplayModel)
organization.​vendorProfilesVendorProfilePreviewModel (object) or string
One of:
organization.​parentOrganizationobject(OrganizationChildDisplayModel)
organization.​childOrganizationsArray of objects(OrganizationChildDisplayModel)
organization.​onBoardingPartnerstring
Deprecated
Example: "a9c5be63-caa4-4e84-8ef1-505e8298f36e"
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"
Response
application/json
{
  "name": "Nursing Staff",
  "description": "Handles patient care",
  "color": "#FF5733",
  "icon": "stethoscope",
  "type": "department",
  "id": "05429248-9b06-4d8f-adde-464a41b79beb",
  "code": "nursing_staff",
  "organization": {
    "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": { … },
    "parentOrganization": { … },
    "onBoardingPartner": "a9c5be63-caa4-4e84-8ef1-505e8298f36e",
    "childOrganizations": [ … ]
  },
  "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"
  }
}

Add a member to a team.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
Bodyapplication/jsonrequired
personIdstringrequired

Person ID

Example: "2e7a1229-e4c4-44db-a514-33e476425809"
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}/members' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "personId": "2e7a1229-e4c4-44db-a514-33e476425809"
  }'

Responses

Bodyapplication/json
idstringrequired
Example: "d98edc3a-6e81-442e-8961-37bc3a819d63"
teamIdstringrequired
Example: "51bcf06d-9195-4eb1-ba73-d5b930ffd9fc"
personobject(TeamPersonDto)required
person.​idstringrequired
Example: "a01c8f0c-95a1-4e94-b6c7-5074f95cd745"
person.​firstNamestringrequired
Example: "string"
person.​lastNamestringrequired
Example: "string"
person.​emailAddressstringrequired
Example: "string"
joinedAtstring(date-time)required
Example: "2025-03-10T16:54:13.337Z"
addedByPersonstring or nullrequired
Example: "ffa24dd5-a925-4a06-b5d9-b49c9fa81c9a"
Response
application/json
{
  "id": "d98edc3a-6e81-442e-8961-37bc3a819d63",
  "teamId": "51bcf06d-9195-4eb1-ba73-d5b930ffd9fc",
  "person": {
    "id": "a01c8f0c-95a1-4e94-b6c7-5074f95cd745",
    "firstName": "string",
    "lastName": "string",
    "emailAddress": "string"
  },
  "joinedAt": "2025-03-10T16:54:13.337Z",
  "addedByPerson": "ffa24dd5-a925-4a06-b5d9-b49c9fa81c9a"
}

Remove a member from a team.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
personIdstringrequired
curl -i -X DELETE \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}/members/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

List all members of a team.

Request

Security
bearer
Path
teamIdstringrequired
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 "joinedAt"
Enum"firstName""lastName""joinedAt"
Example: sort_by=joinedAt
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/teams/{teamId}/members?order_by=ASC&skip=0&take=10&sort_by=joinedAt' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

List all teams that a person is a member of.

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 "createdAt"
Enum"name""createdAt""updatedAt"
Example: sort_by=createdAt
statusArray of strings
Items Enum"active""inactive"
curl -i -X GET \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/persons/{personId}/teams?order_by=ASC&skip=0&take=10&sort_by=createdAt&status=active' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Archive a team.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Restore a team from being archived.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Delete a team.

Request

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

Responses

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

Set a team to an inactive state.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Set a team to an active state.

Request

Security
bearer
Path
organizationIdstringrequired
teamIdstringrequired
curl -i -X POST \
  'https://docs.ecg-api.com/_mock/products/organizations/apis/orgs/organizations/{organizationId}/teams/{teamId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Vendor Profiles

Operations