eeds API

Participants

Participants are those who attend CME activities. The eeds API exposes endpoints to list, retrieve, and search participants.

The participant model

The participant model contains selected information about a participant.

Properties

  • Name
    pin
    Type
    string
    Description

    The participant's PIN serves as the unique identifier for the participant.

  • Name
    firstName
    Type
    string
    Description

    The participant's first name.

  • Name
    lastName
    Type
    string
    Description

    The participant's last name.

  • Name
    degree
    Type
    string
    Description

    The participant's degree.

  • Name
    specialty
    Type
    string
    Description

    The participant's primary specialty.

  • Name
    address
    Type
    string
    Description

    The participant's practice address.

  • Name
    city
    Type
    string
    Description

    The city in which the participant practices.

  • Name
    state
    Type
    string
    Description

    The state in which the participant practices.

  • Name
    postalCode
    Type
    string
    Description

    The postal code of the participant's practice.

  • Name
    email
    Type
    string
    Description

    The participant's email address.

  • Name
    isPaid
    Type
    boolean
    Description

    Whether the participant has a paid eeds account.

  • Name
    customIdentifiers
    Type
    array
    Description

    The custom identifiers used by the sponsor with which the participant is associated.

GET/participants

List participants

This endpoint allows you to retrieve a paginated list of all of the participants you are authorized to access. By default, a maximum of 20 activities are shown per page.

Optional query parameters

  • Name
    page
    Type
    integer
    Description

    The page of results to return.

  • Name
    perPage
    Type
    integer
    Description

    The number of results to return per page.

  • Name
    isPaid
    Type
    boolean
    Description

    If true, only return participants with a paid eeds account. If false, only return participants without a paid eeds account.

Request

GET
/participants
curl -G https://newapi.eeds.com/api/activities \
  -H "Authorization: Bearer {token}"

Response

{
  "pageSize": 50,
  "currentPage": 1,
  "totalItems": 321,
  "totalPages": 7,
  "data": [
    {
      "pin": "01000001",
      "firstName": "J. Paul",
      "lastName": "Martin",
      "degree": "MD",
      "specialty": "Addictionology",
      "address": "One Oak Plaza #302",
      "city": "Asheville",
      "state": "NC",
      "postalCode": "28801",
      "email": "paul@example.com",
      "isPaid": true,
      "customIdentifiers": [
        {
          "name": "eeds Custom ID",
          "value": "123456",
        }
      ]
    },
    {
      "pin": "10163379",
      "firstName": "Ryan",
      "lastName": "Martin",
      "degree": "BS",
      "specialty": "Other",
      "address": "1 Maple Street",
      "city": "San Jose",
      "state": "CA",
      "postalCode": "95112",
      "email": "ryan@example.com",
      "isPaid": false,
      "customIdentifiers": []
    },
    {
      "pin": "43233459"
      // ...
    }
  ]
}
GET/participants/:pin

Retrieve a participant

This endpoint allows you to retrieve a participant's information by providing their PIN. Refer to the list at the top of this page to see which properties are included with participant objects.

Request

GET
/participants/99001200
curl -G https://newapi.eeds.com/api/participants/99001200 \
  -H "Authorization: Bearer {token}"

Response

{
  "pin": "99001200",
  "firstName": "Lewis",
  "lastName": "Alberstone",
  "degree": "MD",
  "specialty": "Addictionology",
  "address": "6543 West Henderson Road",
  "city": "Asheville",
  "state": "NC",
  "postalCode": "28801",
  "email": "lewis@example.com",
  "isPaid": true,
  "customIdentifiers": [
    {
      "name": "eeds Custom ID",
      "value": "123456",
    }
  ]
}
GET/participants/search

Search participant

This endpoint allows you to search for participant by name. In order to provide optimal response times, it returns a paginated list of results containing a limited subset of attributes from the standard participant object. Unlike paginated responses for non-searchable endpoints, the number of results is not configurable and a maximum of 50 results will be returned per request.

Required query parameters

  • Name
    query
    Type
    string
    Description

    The search query string.

Optional query parameters

  • Name
    page
    Type
    integer
    Description

    The page of results to return.

Request

GET
/participants/search
curl -G https://newapi.eeds.com/api/participants/search \
  -H "Authorization: Bearer {token}" \
  --data-urlencode query="martin"

Response

{
  "pageSize": 50,
  "currentPage": 1,
  "totalItems": 321,
  "totalPages": 7,
  "data": [
    {
      "pin": "01000001",
      "firstName": "J. Paul",
      "lastName": "Martin",
      "degree": "MD",
      "specialty": "Addictionology",
      "address": "One Oak Plaza #302",
      "city": "Asheville",
      "state": "NC",
      "postalCode": "28801",
      "email": "paul@example.com",
      "isPaid": true,
      "customIdentifiers": [
        {
          "name": "eeds Custom ID",
          "value": "123456",
        }
      ]
    },
    {
      "pin": "10163379",
      "firstName": "Ryan",
      "lastName": "Martin",
      "degree": "BS",
      "specialty": "Other",
      "address": "1 Maple Street",
      "city": "San Jose",
      "state": "CA",
      "postalCode": "95112",
      "email": "ryan@example.com",
      "isPaid": false,
      "customIdentifiers": []
    },
    {
      "pin": "43233459"
      // ...
    }
  ]
}