CROWDMANAGERCROWDMANAGER

Participants

Description

Representation of contact info and personal data of a participant of a Campaign.

Fields

Name Description Type/Supported Values Supported Methods
id Id of the participant long GET
firstName The first name of the participant string GET
lastName The last name of the participant string GET
emailAddress The email address of the participant string GET
campaignAppId Id of the campaignApp long GET

Permissions

Read a list

Returns a list of the campaign participants for given organization and provided query parameters.

Endpoint

GET https://api.crowdmanager.io/v2/{organization-id}/campaign/participants

QUERY Parameters

Name Description Required
campaignAppId Id of the particular Campaign. It will limit queried participants to the ones that belong to this one Campaign. False
pageSize Maximum returned participants. Defaults to 50. False
pageIndex Skip certain amount of pages. Zero indexed. False

Example

Request

GET https://api.crowdmanager.io/v2/1201/campaign/participants?campaignAppId=1751&pageSize=20&pageIndex=2
Authorization: Basic aaabbbccc111222333
Accept: application/vnd.api+json

Response

  {
    "campaignAppParticipants": [{
        "id": "1753",
        "href": "https://api.crowdmanager.io/v2/1201/campaign/participants/1753",
        "type": "campaignAppParticipants",
        "firstName": "Albert",
        "lastName": "Osaldis",
        "emailAddress": "albertos@wpo.pl",
        "campaignAppId": 1751
    }, {
        "id": "1754",
        "href": "https://api.crowdmanager.io/v2/1201/campaign/participants/1754",
        "type": "campaignAppParticipants",
        "firstName": "Daniel",
        "lastName": "Skivanski",
        "emailAddress": "danielski@wpo.pl",
        "campaignAppId": 1751
    }, {
        "id": "1755",
        "href": "https://api.crowdmanager.io/v2/1201/campaign/participants/1755",
        "type": "campaignAppParticipants",
        "firstName": "Andreas",
        "lastName": "Mike",
        "emailAddress": "andreasdas@onet.pl",
        "campaignAppId": 1751
    }]
}

Read

Returns single participant for given id.

Endpoint

GET https://api.crowdmanager.io/v2/{organization-id}/campaign/participants/{id}

Example

Request

GET https://api.crowdmanager.io/v2/1201/campaign/participants/1241
Authorization: Basic aaabbbccc111222333
Accept: application/vnd.api+json

Response


{
    "campaignAppParticipants": {
        "id": "1753",
        "href": "https://api.crowdmanager.io/v2/1201/campaign/participants/1241",
        "type": "campaignAppParticipants",
        "firstName" : "Karolja",
        "lastName": "Sekulalaen",
        "emailAddress": "karolja@sekulanen.al",
        "campaignAppId": 1751
    }
}