Guides

Add Employee

Suggest Edits

📘

Access Token

The Access token should be requested with employee scope

❗️

Duplications

to prevent duplications you can send X-Request-ID ( value: string) in the header

NameTypeDesc.
URLhttps://business-api.gett.com/v1/employees?businessId=
first_name (mandatory)stringEmployee first name
last_name (mandatory)stringEmployee last name
email (mandatory)stringEmployee email address - bookers, admins and finance will login to the web platform using the email address as a username
phone (mandatory)stringemployee's phone number, the employee will use the phone number to login into the app and ride.

NOTE:phone numbers must be passed in the international format (without "+" sign) as specified in RFC3966.
cost_centrestringcost center that will be assigned to employee rides in reports for client financial and management purposes
departmentstringdepartment that will be assigned to employee rides in reports for client financial and management purposes
external_idstringid that will allow the client to identify the user in his internal systems

the value is not validated by Gett
cost_limitobjectMonthly spending allowance per employee. Required if a company uses allowances
cost_limit.limitintegerSpending allowance value. Send 0 to set unlimited allowance or send a specific value (from 1 to 999,999) to limit the spend
rolestringfrom predefined list:
admin
 booker
finance
 passenger

default value is passenger
can_book_for_themselvesbooleanif true, the employee will be able to request orders via the app/web according to the client policy

default value is false
booker_permissionsobjectfor bookers only, if will be sent for any other role, it will be disregarded
booker_permissions.can_book_for_all_empbooleanif false the booker will be able to request orders only to employees assigned to him

default value is true
booker_permissions.can_book_for_guestbooleanif false the booker will be able to request orders only for registered/ listed employees

default value is true
bookersarray of stringsemployee id's of bookers that will be allowed to view, modify and track employee orders
booker_permissions.can_view_their_own_orders_onlybooleanif true the booker will be able to track only orders requested by him

default value is false
policy_groupobjecttravel policy that will be assigned to employee

default value is No Restrictions group
policy_group.uuidstringpolicy group identifier
home_addressobjectemployee home address, if provided, it will allow the bookers to select the address from list and/or allow travel policy by location
home_address.latfloatLocation latitude
home_address.lngfloatLocation longitude
home_address.addressobjectbreakdown of the address
home_address.address.full_addressstring
home_address.address.housestring
home_address.address.streatstring
home_address.address.citystring
home_address.address.countrystring
home_address.address.postcodestring
home_address.address.address_placeobjectsending address_place details is very recommended as it allows Gett to request missing info about the address with geocoding - which can cause in change in the provided address
home_address.address.address_place.idstring
home_address.address.address_place.providerstring
work_addressobjectemployee work address, if provided, it will allow the bookers to select the address from list and/or allow travel policy by location
work_address.latfloat
work_address.lngfloat
work_address.addressobject
work_address.address.full_addressstring
work_address.address.housestring
work_address.address.streatstring
work_address.address.citystring
work_address.address.countrystring
work_address.address.postcodestring
work_address.address.address_placeobjectsending address_place details is very recommended as it allows Gett to request missing info about the address with geocoding - which can cause in change in the provided address
work_address.address.address_place.idstring
work_address.address.address_place.providerstringsupported provider
google
postcode - for the UK (postcode anywhere)
curl --request POST \
     --url 'https://business-api.gett.com/v1/employees?businessId=rt345retert55' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'X-Request-ID: 5tr54re87t-yi7y7t' \
     --data '
{
     "first_name": "Zoe",
     "last_name": "miller",
     "email": "[email protected]",
     "phone": "447921524856",
     "cost_centre": "Supply",
     "department": "Marketing",
     "external_id": "A5124",
     "cost_limit": {
          "limit": 100
        },
     "role": "passenger",
     "can_book_for_themselves": true,
     "bookers": [
          "34234gr",
          "fert5t533",
          "4545tretr3e"
     ],
     "booker_permissions": {
          "can_book_for_all_emp": true,
          "can_book_for_guest": true,
          "can_view_their_own_orders_only": false
     },
     "policy_group": {
        "uuid": "90e55a13-7343-4a02-a5ad-d0d0c0edf1be"
    },
     "home_address": {
          "lat": 51.54621215,
          "lng": -0.25154644,
          "address": {
               "full_address": "1 plough place, london uk",
               "house": "1",
               "street": "Plough Pl",
               "city": "london",
               "country": "Great Britain",
               "postcode": "EC4A 1DE",
               "address_place": {
                    "id": "euwe09383",
                    "provider": "google"
               }
          }
     },
     "work_address": {
          "lat": 54.1214952,
          "lng": -0.5314484,
          "address": {
               "full_address": "65A Holly St, London UK",
               "house": "65A",
               "street": "Holly St",
               "city": "london",
               "country": "Great Britain",
               "postcode": "E8 3HS",
               "address_place": {
                    "id": "d564fd6w4f6wd",
                    "provider": "google"
               }
          }       
     }
}
'

Response

{
     "id":"8d50ef79-2530-4924-b89e-10ed9f035d8b",
     "first_name": "Zoe",
     "last_name": "miller",
     "email": "[email protected]",
     "phone": "447921524856",
     "cost_centre": "Supply",
     "department": "Marketing",
     "external_id": "A5124",
     "role": "passenger",
     "can_book_for_themselves": true,
     "bookers": [
          "34234gr",
          "fert5t533",
          "4545tretr3e"
     ],
     "booker_permissions": {
          "can_book_for_all_emp": true,
          "can_book_for_guest": true,
          "can_view_their_own_orders_only": false
     },
     "policy_group": {
        "uuid": "90e55a13-7343-4a02-a5ad-d0d0c0edf1be"
    },
     "home_address": {
          "lat": 51.54621215,
          "lng": -0.25154644,
          "address": {
               "full_address": "1 plough place, london uk",
               "house": "1",
               "street": "Plough Pl",
               "city": "london",
               "country": "Great Britain",
               "postcode": "EC4A 1DE",
               "address_place": {
                    "id": "euwe09383",
                    "provider": "google"
               }
          }
     },
     "work_address": {
          "lat": 54.1214952,
          "lng": -0.5314484,
          "address": {
               "full_address": "65A Holly St, London UK",
               "house": "65A",
               "street": "Holly St",
               "city": "london",
               "country": "Great Britain",
               "postcode": "E8 3HS",
               "address_place": {
                    "id": "d564fd6w4f6wd",
                    "provider": "google"
               }
          }       
     }
}

Updated almost 2 years ago