Query parameters

• advanced_search integer
• schedule_id string
• course_id integer
• place_id integer
• room_id integer
• trainer_id integer
• billing_period_id integer
• billing_status string

  Values are paid, unpaid, partially_paid, or overpaid.

• user string
• user_id integer
• email string(email)
• registration_id integer
• exclude string

  Exclude certain registrations from results

• exclude_user string

  Exclude certain users from results

• order_id integer

  Search registrations by related order id

• parent integer

  Show related / linked orders by their parent

• distinct boolean

  Return only distinct users (one registration per user)

• payment_id integer

  Find registration related to payment

• inactive_customers boolean

  Show registrations for inactive customers

  Default value is false.

• marketing_messages boolean

  Return registrations that belong to users which have enabled marketing messages

  Default value is false.

• ef_full_name string
• page integer
• page_size integer

  Default value is 20.

• status string

  Values are registered, deleted, late, waitlist, quest, or canceled.

• created_from string(date)
• created_to string(date)
• schedule_groups string
• schedule_query string

  Filter registration based on a Query of schedules - Use JSON.stringify() to pass query as string

Responses

• 200 application/json

  List of registrations

  Hide response attributes Show response attributes object

  • total integer
  • page integer
  • results array[object]
    Hide results attributes Show results attributes object

    • registration_id integer
    • note string
    • created string(date-time)
    • updated string(date-time)
    • course_id integer
    • schedule_id integer
    • company_note string
    • billing_period_id integer
    • paid integer(float)
    • payment_method string
    • status string
    • user_id integer
    • first_name string
    • last_name string
    • email string
    • phone string
    • full_name string
    • payment_balance integer(float)
    • payment_debt integer(float)
    • payment_paid integer(float)
    • __calc__paid integer(float)
    • __calc__course_payment integer(float)
    • __calc__registration_fee integer(float)
    • payment_status string
    • internal_note string
    • ef_full_name string
    • ef_dob string
    • ef_address string
    • ef_business_name string
    • ef_business_address string
    • ef_business_id string
    • ef_tax_id string
    • ef_vat string
    • ef_extra_field_1 string
    • ef_extra_field_2 string
    • ef_extra_field_3 string
    • ef_extra_field_4 string
    • ef_extra_field_5 string
    • role string
    • first_event string(date-time)
    • events_attended integer
    • registrations_count integer
    • total_events integer