light-mode-image
Learn
API ReferenceParticipant contacts

Retrieve all participant points of contact

Roles

admindts-provider

Analytics Events

ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_STARTECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_SUCCESSECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_FAIL
GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts

Retrieve all points of contact for given participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_START
  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

participantId*string

The UUID of the participant

Formatuuid
ecosystemId*string

The UUID of the ecosystem

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000
Default100
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/participants/497f6eca-6276-4993-bfeb-53cbbbba6f08/contacts"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "fullName": "string",      "active": true,      "emailAddress": "user@example.com",      "primaryPhoneNumber": "string",      "secondaryPhoneNumber": "string",      "createdBy": {        "clientId": "string",        "managementUserId": "string"      },      "createdAt": "2019-08-24T14:15:22Z",      "lastModifiedBy": {        "clientId": "string",        "managementUserId": "string"      },      "lastModifiedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}

How would you rate this page?

Create a participant point of contact POST

Create a new point of contact for the specified participant. A maximum of 10 contacts can exist per participant. ### **Analytic events** * ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_START * ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_SUCCESS * ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_FAIL

Retrieve a participant point of contact GET

Retrieve a specific point of contact for a given participant. ### **Analytic events** * ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_START * ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_SUCCESS * ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_FAIL