Download course participants using GET.
For every API request you make, you'll need to present the API access key in the HTTP Header as X-API-Key to be authenticated.
| Name | Required | Value | Description |
|---|---|---|---|
| course_id | optional | number | |
| coursedate_id | optional | number | |
| customer_id | optional | number | If related to a customer |
| limit | optional | number | Amount of results (default: 75) (maximum: 250) |
| page | optional | number | Page to show (default: 1) |
| since_id | optional | number | Restrict results to after the specified ID. |
| created_at_min | optional | string | Show items created after date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| created_at_max | optional | string | Show items created before date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| updated_at_min | optional | string | Show items last updated after date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
| updated_at_max | optional | string | Show items last updated before date (format: yyyy-mm-dd OR yyyy-mm-dd hh:mm:ss) |
$request_url = 'https://www.kursguiden.no/api/v2/participants';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'X-API-Key: {your-api-key}',
'Accept: application/json',
));
$result = curl_exec($ch);
curl_close($ch);
If the method is successful it responds with an JSON structure, as it is shown below.
[
{
"archived_at": null,
"booker_admin_user": null,
"booker_email": null,
"booker_language_id": null,
"booker_name": null,
"booker_phone": null,
"certificate_issued_at": null,
"completed": false,
"course": {
"id": 22353,
"title": "Learn REST API",
"reference": "RESTAPI-CA-1001",
"created_at": "2015-01-21T21:30:31+01:00",
"updated_at": "2024-05-03T21:54:44+02:00"
},
"coursedate": {
"id": 12746584,
"idCourse": 22353,
"idStatus": 1,
"week": 20,
"start_at": "2025-05-15",
"end_at": "2025-05-15",
"deadline_at": "2025-05-15",
"time_start": "08:00",
"time_end": "12:05",
"timezone": null,
"gmt_offset": null,
"place": "Sem",
"is_virtual": false,
"event_url": null,
"internal_note": null,
"idLocation": "6489",
"teaching_language": "Norwegian",
"idTeachingLanguage": "no",
"location_cancellation_days": null,
"is_deleted": false,
"location": {
"id": 6489,
"title": "Sem",
"custom_title": null,
"address": null,
"address2": null,
"address3": null,
"zipcode": null,
"city": null,
"state": "Vestfold",
"county": "Sem",
"idCountry": 159,
"country": "Norway",
"country_code": "NO",
"idPlace": 1226,
"lat": 59.2823015,
"lng": 10.3300322,
"timezone": null,
"long_text": null,
"short_text": null,
"short_text_2": null,
"idInstructor": null,
"is_default": false,
"is_archived": false,
"is_virtual": false
}
},
"created_at": "2021-11-25T15:52:56+01:00",
"custom_properties": null,
"entry_source": "School",
"id": 524957,
"idBooking": 480070,
"idOrder": 230612,
"no_show": false,
"paid": {
"id": 3,
"title": "No"
},
"passed": false,
"status": {
"id": 1,
"title": "Booked",
"status_code": "status_confirmed"
},
"updated_at": "2021-11-25T15:52:56+01:00",
"user": {
"id": 462355,
"firstname": null,
"lastname": "Per",
"email": "Larsen",
"username": "username_75cba24e",
"phone": "33356699",
"company": "Beste Kunde AS",
"orgnr": "85454545",
"position": null,
"department": null,
"legaldepartment": null,
"date_of_birth": null,
"invoice_address": {
"address": "Kundeveien 10",
"address_2": null,
"address_3": null,
"zipcode": "2130",
"city": "Oslo",
"invoice_phone": null
},
"home_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"work_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"external_id": null,
"customer": {
"id": 32714,
"title": "Beste Kunde AS",
"department": null,
"phone": null,
"fax": null,
"email": null,
"webaddress": null,
"orgnr": "85454545",
"invoice_email": null,
"customer_reference_id": null,
"customer_reference": "Per Pedersen",
"note": null,
"turnover": null,
"idParentCustomer": null,
"invoice_method": "electronic",
"country": {
"id": 159,
"title": "Norway",
"code": "NO"
},
"status": "Deactivated",
"type": "Company",
"duedate_days": 10,
"seller": null,
"invoice_address": {
"address": "Kundeveien 10",
"address_2": null,
"address_3": null,
"zipcode": "2130",
"city": "Oslo"
},
"post_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"visit_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"custom_properties": null,
"created_at": "2017-03-31T20:27:41+02:00",
"updated_at": "2024-04-05T06:06:52+02:00"
},
"created_at": "2021-11-25T15:52:56+01:00",
"updated_at": "2024-03-03T03:34:14+01:00"
},
"user_comment": null
},
{
"archived_at": null,
"booker_admin_user": null,
"booker_email": null,
"booker_language_id": null,
"booker_name": null,
"booker_phone": null,
"certificate_issued_at": "2019-09-11",
"completed": false,
"course": {
"id": 22353,
"title": "Learn REST API",
"reference": "RESTAPI-CA-1001",
"created_at": "2015-01-21T21:30:31+01:00",
"updated_at": "2024-05-03T21:54:44+02:00"
},
"coursedate": {
"id": 12746584,
"idCourse": 22353,
"idStatus": 1,
"week": 20,
"start_at": "2025-05-15",
"end_at": "2025-05-15",
"deadline_at": "2025-05-15",
"time_start": "08:00",
"time_end": "12:05",
"timezone": null,
"gmt_offset": null,
"place": "Sem",
"is_virtual": false,
"event_url": null,
"internal_note": null,
"idLocation": "6489",
"teaching_language": "Norwegian",
"idTeachingLanguage": "no",
"location_cancellation_days": null,
"is_deleted": false,
"location": {
"id": 6489,
"title": "Sem",
"custom_title": null,
"address": null,
"address2": null,
"address3": null,
"zipcode": null,
"city": null,
"state": "Vestfold",
"county": "Sem",
"idCountry": 159,
"country": "Norway",
"country_code": "NO",
"idPlace": 1226,
"lat": 59.2823015,
"lng": 10.3300322,
"timezone": null,
"long_text": null,
"short_text": null,
"short_text_2": null,
"idInstructor": null,
"is_default": false,
"is_archived": false,
"is_virtual": false
}
},
"created_at": "2020-04-27T22:57:02+02:00",
"custom_properties": null,
"entry_source": "School",
"id": 358889,
"idBooking": 347776,
"idOrder": 131297,
"no_show": false,
"paid": {
"id": 3,
"title": "No"
},
"passed": false,
"status": {
"id": 7,
"title": "Not confirmed",
"status_code": "status_unconfirmed"
},
"updated_at": "2020-04-27T22:57:02+02:00",
"user": {
"id": 338204,
"firstname": "Anonymous",
"lastname": "User",
"email": null,
"username": null,
"phone": null,
"company": null,
"orgnr": null,
"position": null,
"department": null,
"legaldepartment": null,
"date_of_birth": "2020-01-01",
"invoice_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": "Oslo",
"invoice_phone": null
},
"home_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": "Oslo"
},
"work_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"external_id": null,
"customer": {
"id": 32714,
"title": "Beste Kunde AS",
"department": null,
"phone": null,
"fax": null,
"email": null,
"webaddress": null,
"orgnr": "85454545",
"invoice_email": null,
"customer_reference_id": null,
"customer_reference": "Per Pedersen",
"note": null,
"turnover": null,
"idParentCustomer": null,
"invoice_method": "electronic",
"country": {
"id": 159,
"title": "Norway",
"code": "NO"
},
"status": "Deactivated",
"type": "Company",
"duedate_days": 10,
"seller": null,
"invoice_address": {
"address": "Kundeveien 10",
"address_2": null,
"address_3": null,
"zipcode": "2130",
"city": "Oslo"
},
"post_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"visit_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"custom_properties": null,
"created_at": "2017-03-31T20:27:41+02:00",
"updated_at": "2024-04-05T06:06:52+02:00"
},
"created_at": "2020-04-27T22:57:01+02:00",
"updated_at": "2024-04-30T16:03:50+02:00"
},
"user_comment": null
},
{
"archived_at": null,
"booker_admin_user": null,
"booker_email": null,
"booker_language_id": null,
"booker_name": null,
"booker_phone": null,
"certificate_issued_at": null,
"completed": false,
"course": {
"id": 22353,
"title": "Learn REST API",
"reference": "RESTAPI-CA-1001",
"created_at": "2015-01-21T21:30:31+01:00",
"updated_at": "2024-05-03T21:54:44+02:00"
},
"coursedate": {
"id": 9304757,
"idCourse": 22353,
"idStatus": 1,
"week": 1,
"start_at": "2020-01-04",
"end_at": "2020-01-06",
"deadline_at": "2020-01-03",
"time_start": "06:00",
"time_end": "07:30",
"timezone": null,
"gmt_offset": null,
"place": "Sem",
"is_virtual": false,
"event_url": null,
"internal_note": null,
"idLocation": "6489",
"teaching_language": "Norwegian",
"idTeachingLanguage": "no",
"location_cancellation_days": null,
"is_deleted": false,
"location": {
"id": 6489,
"title": "Sem",
"custom_title": null,
"address": null,
"address2": null,
"address3": null,
"zipcode": null,
"city": null,
"state": "Vestfold",
"county": "Sem",
"idCountry": 159,
"country": "Norway",
"country_code": "NO",
"idPlace": 1226,
"lat": 59.2823015,
"lng": 10.3300322,
"timezone": null,
"long_text": null,
"short_text": null,
"short_text_2": null,
"idInstructor": null,
"is_default": false,
"is_archived": false,
"is_virtual": false
}
},
"created_at": "2017-03-31T20:27:04+02:00",
"custom_properties": null,
"entry_source": "User",
"id": 124920,
"idBooking": 166154,
"idOrder": 27244,
"no_show": false,
"paid": {
"id": 1,
"title": "Yes"
},
"passed": false,
"status": {
"id": 7,
"title": "Not confirmed",
"status_code": "status_unconfirmed"
},
"updated_at": "2024-05-03T18:15:56+02:00",
"user": {
"id": 154420,
"firstname": "Lars",
"lastname": "Larsen",
"email": "lars@eksemel.ek",
"username": "lars@eksemel.ek",
"phone": "21212121",
"company": "ABC AS",
"orgnr": null,
"position": null,
"department": null,
"legaldepartment": null,
"date_of_birth": "1992-05-12",
"invoice_address": {
"address": "Veien 2",
"address_2": null,
"address_3": null,
"zipcode": "3120",
"city": "Oslo",
"invoice_phone": null
},
"home_address": {
"address": "Veien 2",
"address_2": null,
"address_3": null,
"zipcode": "3120",
"city": "Oslo"
},
"work_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"external_id": null,
"customer": {
"id": 32714,
"title": "Beste Kunde AS",
"department": null,
"phone": null,
"fax": null,
"email": null,
"webaddress": null,
"orgnr": "85454545",
"invoice_email": null,
"customer_reference_id": null,
"customer_reference": "Per Pedersen",
"note": null,
"turnover": null,
"idParentCustomer": null,
"invoice_method": "electronic",
"country": {
"id": 159,
"title": "Norway",
"code": "NO"
},
"status": "Deactivated",
"type": "Company",
"duedate_days": 10,
"seller": null,
"invoice_address": {
"address": "Kundeveien 10",
"address_2": null,
"address_3": null,
"zipcode": "2130",
"city": "Oslo"
},
"post_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"visit_address": {
"address": null,
"address_2": null,
"address_3": null,
"zipcode": null,
"city": null
},
"custom_properties": null,
"created_at": "2017-03-31T20:27:41+02:00",
"updated_at": "2024-04-05T06:06:52+02:00"
},
"created_at": "2017-03-31T20:27:04+02:00",
"updated_at": "2024-04-11T03:21:35+02:00"
},
"user_comment": "Eksempel p\u00e5 kommentar"
}
]
Unsuccessful response sample:
{
"error": "Wrong API Key"
}
