Search for course users

Search for users using a keyword using GET.

Request

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.

Parameters

Name	Required	Value	Description
email	required	string	At least one of email, firstname, lastname, username is required
firstname	required	string	At least one of email, firstname, lastname, username is required
lastname	required	string	At least one of email, firstname, lastname, username is required
username	required	string	At least one of email, firstname, lastname, username is required When booking, if combination of email and name does not exist, a new user is created. If another course user already has the same e-mail address, a username like username_peder_aas is used.

Example code in PHP

$request_url = 'https://api.frontcore.com/v2/search-users?lastname=Larsen';
$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);
               

Response

If the method is successful it responds with an JSON structure, as it is shown below.

[
    {
        "id": 154420,
        "firstname": "Lars",
        "lastname": "Larsen",
        "email": "lars@eksemel.ek",
        "username": "lars@eksemel.ek",
        "phone": "21212121",
        "company": "ABC AS",
        "orgnr": "",
        "position": "",
        "department": null,
        "legaldepartment": null,
        "date_of_birth": "1992-05-12",
        "invoice_address": {
            "address": "Veien 2",
            "address_2": "",
            "address_3": "",
            "zipcode": "3120",
            "city": "Oslo",
            "invoice_phone": ""
        },
        "home_address": {
            "address": "Veien 2",
            "address_2": "",
            "address_3": "",
            "zipcode": "3120",
            "city": "Oslo"
        },
        "work_address": {
            "address": "",
            "address_2": "",
            "address_3": "",
            "zipcode": "",
            "city": ""
        },
        "external_id": null,
        "customer": {
            "id": 32714,
            "title": "Beste Kunde AS",
            "department": "",
            "phone": "",
            "fax": "",
            "email": "",
            "webaddress": "",
            "orgnr": "85454545",
            "invoice_email": "",
            "customer_reference_id": "",
            "customer_reference": "Per Pedersen",
            "note": "",
            "turnover": "",
            "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": "",
                "address_3": "",
                "zipcode": "2130",
                "city": "Oslo"
            },
            "post_address": {
                "address": "",
                "address_2": "",
                "address_3": "",
                "zipcode": "",
                "city": ""
            },
            "visit_address": {
                "address": "",
                "address_2": "",
                "address_3": "",
                "zipcode": "",
                "city": ""
            },
            "custom_properties": null,
            "created_at": "2017-03-31T20:27:41+02:00",
            "updated_at": "2024-12-18T08:25:22+01:00"
        },
        "created_at": "2017-03-31T20:27:04+02:00",
        "updated_at": "2024-12-05T03:22:56+01:00"
    }
]

Unsuccessful response sample:

{
    "error": "Wrong API Key"
}