Add Employee

📘

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

Name

Type

Desc.

URL

https://business-api.gett.com/v1/employees?businessId=

first_name (mandatory)

string

Employee first name

last_name (mandatory)

string

Employee last name

email (mandatory)

string

Employee email address - bookers, admins and finance will login to the web platform using the email address as a username

phone (mandatory)

string

employee'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_centre

string

cost center that will be assigned to employee rides in reports for client financial and management purposes

department

string

department that will be assigned to employee rides in reports for client financial and management purposes

external_id

string

id that will allow the client to identify the user in his internal systems

the value is not validated by Gett

cost_limit

object

Monthly spending allowance per employee. Required if a company uses allowances

cost_limit.limit

integer

Spending allowance value. Send 0 to set unlimited allowance or send a specific value (from 1 to 999,999) to limit the spend

role

string

from predefined list:

  • admin
  • booker
  • finance
  • passenger

default value is passenger

can_book_for_themselves

boolean

if true, the employee will be able to request orders via the app/web according to the client policy

default value is false

booker_permissions

object

for bookers only, if will be sent for any other role, it will be disregarded

booker_permissions.can_book_for_all_emp

boolean

if false the booker will be able to request orders only to employees assigned to him

default value is true

booker_permissions.can_book_for_guest

boolean

if false the booker will be able to request orders only for registered/ listed employees

default value is true

bookers

array of strings

employee id's of bookers that will be allowed to view, modify and track employee orders

booker_permissions.can_view_their_own_orders_only

boolean

if true the booker will be able to track only orders requested by him

default value is false

policy_group

object

travel policy that will be assigned to employee

default value is No Restrictions group

policy_group.uuid

string

policy group identifier

home_address

object

employee home address, if provided, it will allow the bookers to select the address from list and/or allow travel policy by location

home_address.lat

float

Location latitude

home_address.lng

float

Location longitude

home_address.address

object

breakdown of the address

home_address.address.full_address

string

home_address.address.house

string

home_address.address.streat

string

home_address.address.city

string

home_address.address.country

string

home_address.address.postcode

string

home_address.address.address_place

object

sending 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.id

string

home_address.address.address_place.provider

string

work_address

object

employee work address, if provided, it will allow the bookers to select the address from list and/or allow travel policy by location

work_address.lat

float

work_address.lng

float

work_address.address

object

work_address.address.full_address

string

work_address.address.house

string

work_address.address.streat

string

work_address.address.city

string

work_address.address.country

string

work_address.address.postcode

string

work_address.address.address_place

object

sending 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.id

string

work_address.address.address_place.provider

string

supported 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"
               }
          }       
     }
}

Did this page help you?