List Participants

GET Endpoint

https://data-api.witcontests.com/experience/participants

The GET /experience/participants call is a premium data feature that can be used to list all of your participants across every activation. Contact your WIT representative for more information on unlocking this feature along with other premium data capabilities.

Example

Getting a list of participants with curl

curl https://data-api.witcontests.com/experience/participants \
    -H 'Authorization: Api-Key <API KEY>'

/experience/participants JSON example response

{
  "participants": [
    {
      "id": "5aaddb9b5b3346cbba253718d22b59dd",
      "email": "janedoe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "extras": [],
      "activationsEntered": []
      "firstEnteredAt": {
        "iso": "2022-04-29T21:37:49.000Z",
        "ts": 1651268269
      }
    },
    ...
  ],
    "next": null
}

URL parameter options

info

All URL parameters are optional.

"start_date"

The "start_date" parameter can be used to retrieve participants that first entered on or after a specific date. The date format should be an ISO date string, in YYYY-MM-DD format.

To only retrieve participants that first entered on or after August 1st, 2022, set the parameter to start_date=2022-08-01.

"end_date"

The "end_date" parameter can be used to retrieve participants that first entered on or before a specific date. The date format should be an ISO date string, in YYYY-MM-DD format.

To only retrieve participants that first entered on or before August 1st, 2022, set the parameter to end_date=2022-08-01.

"limit"

The "limit" parameter determines the maximum number of participants returned in the response list. This can be a number between 1 and 100.

If your filters would result in more participants than your limit allows, you can use ID-based pagination to retrieve the next page of results. See the "next" parameter below for more information.

"next"

The "next" parameter can be used to paginate through the list of participants.

If your request has more results than your limit allows for, the "next" key in the response object will have an ID string as its value. To get the next page of results, make a new request with the "next" URL parameter added, the value of which should be the "next" ID from the previous response.

For example, if you make a list call request and receive this response:

{
    "participants": [...],
    "next": "nkO8BDi42G4x"
}

Then your following list call should have the parameter next=nkO8BDi42G4x set.

If there are no more results, the value of "next" in the response will be null.

Response schema

"participants"

"participants" is a list of Participant objects.

"next"

See the documentation for the "next" request parameter.