List All Participants

GET /v1/participants

Responses

200 application/json

Participant Response
Hide response attribute Show response attribute object
- data array[object]
  
  A potential/future/current/past participant
  
  Hide data attributes Show data attributes object
  
  birthCity string
  
  Participant birth city
  
  birthCountry string
  
  Participant birth country
  
  customerNumber string
  
  Participant customer number
  
  date_of_birth string(date)
  
  Birth date
  
  email string(email) Required
  
  Email address
  
  firstName string
  
  Participant first name
  
  Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.
  
  gender string
  
  Participant gender
  
  Values are diverse, female, or male.
  
  id integer
  
  Participant ID
  
  insertedAt string(date-time)
  
  Creation timestamp
  
  internalCustomerNumber string
  
  Participant internal customer number
  
  lastName string
  
  Participant last name
  
  Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.
  
  marketingChannel string
  
  Participant marketing channel
  
  preferredName string
  
  Participant preferred name
  
  salutation string
  
  Participant salutation
  
  status string
  
  Participant status
  
  Values are lead, future, active, past, dropout, or archived.
  
  updatedAt string(date-time)
  
  Update timestamp

GET /v1/participants

curl \
 -X GET http://localhost:4000/v1/participants \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "first_name": "Melanie",
      "id": "<uuid v4>",
      "last_name": "Muster"
    },
    {
      "first_name": "Melanie",
      "id": "<uuid v4>",
      "last_name": "Muster"
    }
  ]
}