Returns a list of people

GET /api/crm/crmpeople

Query parameters

  • searchString string

    text to search for in the list

  • orderFieldName string

    name of the order field

  • orderFieldSort string

    sorting mode

    Values are DESC or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • withMaxPageNumber string

    returns the number of pages available as a header if this is set

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a list of people

    Hide response attributes Show response attributes object
    • id integer
    • first_name string
    • last_name string
    • number integer
    • manual_number integer
    • number_string string
    • gender string
    • title string
    • position string
    • language string
    • special_salutation string
    • form_of_salutation string
    • birthday string(date-time)
    • known_allergies string
    • confirmed_no_allergies boolean
    • allow_photos boolean
    • allow_leaving_alone boolean
    • authorized_pickup string
    • needs_support boolean
    • support_description string
    • financial_support boolean
    • financial_support_number string
    • municipal_support boolean
    • municipal_support_number string
    • grade_level integer
    • school_class string
    • start_time string(date-time)
    • start_time_reason string
    • end_time string(date-time)
    • end_time_reason string
    • confirmed_gtc_time string(date-time)
    • crm_person_contact_data array[object]
      Hide crm_person_contact_data attributes Show crm_person_contact_data attributes object
      • id integer
      • name string
      • value string
      • generated_value string
      • contact_data_type object
        Hide contact_data_type attributes Show contact_data_type attributes object
        • id integer
        • name string
        • value string
        • allow_self_service boolean
        • deleted boolean
      • search_string string
    • archived boolean
    • subscribed_newsletter boolean
    • subscribed_magazine boolean
    • printed_member_card boolean
    • has_login_user boolean
    • profile_picture_url string
    • log_book_staff boolean
    • log_book_staff1 boolean
    • log_book_staff2 boolean
    • log_book_member boolean
    • log_book_trainer boolean
    • log_book_trainer1 boolean
    • log_book_trainer2 boolean
    • log_book_head_of_department boolean
    • log_book_supervisory_board boolean
    • log_book_board_of_directors boolean
    • log_book_honorary_member boolean
    • log_book_club_card_one boolean
    • log_book_health_recovered boolean
    • log_book_health_vaccinated boolean
    • log_book_health_vaccinated_addition string
    • sync_lanista boolean
    • category object
      Hide category attributes Show category attributes object
      • id integer
      • name string
      • name_plural string
      • description string
      • deleted boolean
      • is_public boolean
      • enabled_customer_create_new boolean
      • customer_register_min_number integer
      • customer_add_ignore_invite_code boolean
      • customer_ui_allowed_ticket_types string
      • enabled_customer_ui_selection boolean
      • order integer
    • nickname string
    • preferred_color_hex string
    • avatar_token string
    • search_string string
    • address string
    • address_street string
    • address_house_number string
    • address_street_level string
    • address_co string
    • address_city string
    • address_zip string
    • address_admin_level1 string
    • address_country string
    • address_full_country string
    • address_geo_lat string
    • address_geo_lng string
    • address_external_provider_id string
    • created string(date-time)
    • updated string(date-time)
    • order integer
GET /api/crm/crmpeople
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/crm/crmpeople' \
 --header "x-session-token: $API_KEY"
Response examples (200)
[
  {
    "id": 42,
    "first_name": "string",
    "last_name": "string",
    "number": 42,
    "manual_number": 42,
    "number_string": "string",
    "gender": "string",
    "title": "string",
    "position": "string",
    "language": "string",
    "special_salutation": "string",
    "form_of_salutation": "string",
    "birthday": "2025-05-04T09:42:00Z",
    "known_allergies": "string",
    "confirmed_no_allergies": true,
    "allow_photos": true,
    "allow_leaving_alone": true,
    "authorized_pickup": "string",
    "needs_support": true,
    "support_description": "string",
    "financial_support": true,
    "financial_support_number": "string",
    "municipal_support": true,
    "municipal_support_number": "string",
    "grade_level": 42,
    "school_class": "string",
    "start_time": "2025-05-04T09:42:00Z",
    "start_time_reason": "string",
    "end_time": "2025-05-04T09:42:00Z",
    "end_time_reason": "string",
    "confirmed_gtc_time": "2025-05-04T09:42:00Z",
    "crm_person_contact_data": [
      {
        "id": 42,
        "name": "string",
        "value": "string",
        "generated_value": "string",
        "contact_data_type": {
          "id": 42,
          "name": "string",
          "value": "string",
          "allow_self_service": true,
          "deleted": true
        },
        "search_string": "string"
      }
    ],
    "archived": true,
    "subscribed_newsletter": true,
    "subscribed_magazine": true,
    "printed_member_card": true,
    "has_login_user": true,
    "profile_picture_url": "string",
    "log_book_staff": true,
    "log_book_staff1": true,
    "log_book_staff2": true,
    "log_book_member": true,
    "log_book_trainer": true,
    "log_book_trainer1": true,
    "log_book_trainer2": true,
    "log_book_head_of_department": true,
    "log_book_supervisory_board": true,
    "log_book_board_of_directors": true,
    "log_book_honorary_member": true,
    "log_book_club_card_one": true,
    "log_book_health_recovered": true,
    "log_book_health_vaccinated": true,
    "log_book_health_vaccinated_addition": "string",
    "sync_lanista": true,
    "category": {
      "id": 42,
      "name": "string",
      "name_plural": "string",
      "description": "string",
      "deleted": true,
      "is_public": true,
      "enabled_customer_create_new": true,
      "customer_register_min_number": 42,
      "customer_add_ignore_invite_code": true,
      "customer_ui_allowed_ticket_types": "string",
      "enabled_customer_ui_selection": true,
      "order": 42
    },
    "nickname": "string",
    "preferred_color_hex": "string",
    "avatar_token": "string",
    "search_string": "string",
    "address": "string",
    "address_street": "string",
    "address_house_number": "string",
    "address_street_level": "string",
    "address_co": "string",
    "address_city": "string",
    "address_zip": "string",
    "address_admin_level1": "string",
    "address_country": "string",
    "address_full_country": "string",
    "address_geo_lat": "string",
    "address_geo_lng": "string",
    "address_external_provider_id": "string",
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "order": 42
  }
]