S
Samva
S
Samva
DashboardAPISamva DocumentationQuickstart GuideAuthentication

API Reference

Email Management

Conversation Management

Bulk Import ParticipantsCreate ParticipantGet ParticipantGet Participant EngagementList ParticipantsRemove ParticipantUpdate Participant

Configuration

Analytics & Operations

OpenAPI Specification
API ReferenceParticipants

List Participants

GET
/participants

Authorization

apiKey
X-API-Key<token>

API key for authentication

In: header

Query Parameters

page?integer
Default1
Range1 <= value <= 9007199254740991
limit?integer
Default20
Range1 <= value <= 100
filters?

Response Body

application/json

curl -X GET "https://samva.app/api/v1/participants"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "type": "human",
      "name": "string",
      "displayName": "string",
      "avatar": "string",
      "channelIdentities": "string",
      "humanProfile": "string",
      "capabilities": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "engagement": "string",
      "accessLevel": "public",
      "accessConfig": "string",
      "preferences": "string",
      "status": "active",
      "statusReason": "string",
      "externalId": "string",
      "metadata": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
      "lastModifiedBy": "ac5c7580-b36d-42f3-a739-e202c634d1d1"
    }
  ],
  "pagination": {
    "page": -9007199254740991,
    "limit": -9007199254740991,
    "total": -9007199254740991,
    "totalPages": -9007199254740991
  }
}

Get Participant Engagement

Previous Page

Remove Participant

Next Page

curl -X GET "https://samva.app/api/v1/participants"