Warning: API Version 1 is deprecated. Please use API Version 2.
Api Documentation

Users

Users are the members that will stay in-the-loop through Bundeling. A user can be bound to a Customer through the customer_id field. When retrieving users, the picture field contains an ID that can be used in the FILES endpoint. Posting or updating user pictures is also done through the FILES endpoint. Please refer to the documentation of said endpoint for more information. The label field is only visible to API keys that do not require user authentication.
listchevron_right
Retrieves a collection of users and information about them.
singlechevron_right
Retrieves a single user and information about him/her.
createchevron_right
Creates a new user. Only available to API keys without user authentication.
updatechevron_right
Updates a user. API keys without user authentication can update all users. API keys that require user authentication can only update the current user.
deletechevron_right
Deletes a single user. Only available to API keys without user authentication.
Json
XML
POST https://api.bundeling.com/V1/users

Parameters

Body

NameDescriptionTypeNillableRequired
customer_idAn integer used to identify the customer that the user will be bound to.intfalsefalse
usernameA unique username that will be used during user login.stringfalsetrue
passwordA password that will be used during user login.stringfalsefalse
nameThe name of the user.stringfalsetrue
functionThe function the user fulfills in a company.stringfalsefalse
birthdayThe date of birth of the user in YYYY-MM-DD format.datefalsefalse
emailThe unique email address of the user. This address will be used when sending the invitation email.stringfalsetrue
telephoneThe users phone number.stringfalsefalse
mobilephoneThe users mobile phone number.stringfalsefalse
linkedinThe linkedin url.stringfalsefalse
notesAdditional notes for Club Managers.stringfalsefalse
external_referenceReference for linking to external systems.stringfalsefalse
hiddenHides this user in the app. This field is only available to API keys without user authentication.booleanfalsefalse
send_inviteSetting this value to true will send an email to this user with login credentials.booleanfalsefalse
labelsThe labels linked to the user. This field is only available to API keys without user authentication.array(int)falsefalse

Example request

Headers

Content-Type:application/json
Api-Key:RAegSX8yZfEbqSPM

Body

{
    "customer_id": 4,
    "username": "johndoe",
    "password": "johndoe123!",
    "name": "John Doe",
    "function": "Employee",
    "birthday": "1986-04-22",
    "email": "johndoe@email.com",
    "telephone": "+31412345678",
    "mobilephone": "+31612345678",
    "linkedin": "https://www.linkedin.com/in/eric-van-den-brand-a4769a/",
    "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
    "external_reference": "123908",
    "hidden": false,
    "send_invite": false,
    "labels": [
        1,
        4,
        10
    ]
}

Example response

{
    "id": 14,
    "customer_id": 6,
    "username": "johndoe",
    "name": "John Doe",
    "function": "Employee",
    "birthday": "1986-04-22",
    "email": "johndoe@email.com",
    "telephone": "+31412345678",
    "mobilephone": "+31612345678",
    "linkedin": "https://www.linkedin.com/in/eric-van-den-brand-a4769a/",
    "picture": "LCJwYeyJjbGllbnQiOjEwXRoIjoidXNlcnNcLzE1XC91...",
    "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
    "external_reference": "123908",
    "hidden": false,
    "labels": [
        1,
        4,
        10
    ]
}