Skip to main content
POST
/
v1
/
users
Create user
curl --request POST \
  --url https://api.light.inc/v1/users \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phoneNumber": {
    "localNumber": "<string>"
  },
  "avatarUrl": "<string>",
  "city": "<string>",
  "address": "<string>",
  "zipcode": "<string>",
  "roles": [],
  "sendWelcomeEmail": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": {
    "localNumber": "<string>"
  },
  "avatarUrl": "<string>",
  "city": "<string>",
  "zipcode": "<string>",
  "address": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "roles": [],
  "groups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "memberCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "managerIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.light.inc/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Body

application/json;charset=UTF-8
​
firstName
string
​
lastName
string
​
email
string
​
companyEntityId
string<uuid>
​
phoneNumber
object

Vendor phone number.

​
avatarUrl
string | null
​
notificationChannel
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
MS_TEAMS,
SLACK,
WEB_APP
​
country
enum<string> | null

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
UNDEFINED,
AC,
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AN,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BU,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CP,
CR,
CS,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DG,
DJ,
DK,
DM,
DO,
DZ,
EA,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
EZ,
FI,
FJ,
FK,
FM,
FO,
FR,
FX,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
IC,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NT,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SF,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SU,
SV,
SX,
SY,
SZ,
TA,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TP,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UK,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XI,
XU,
XK,
YE,
YT,
YU,
ZA,
ZM,
ZR,
ZW
​
city
string | null
​
address
string | null
​
zipcode
string | null
​
roles
enum<string>[]

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
SUPERUSER,
REIMBURSEMENT,
CARDHOLDER,
CONTROLLER,
COMPANY_ADMIN,
VENDOR_MANAGEMENT,
INVOICE_APPROVER,
AP_PREPARATION,
AP_CLERK,
AR_CLERK,
PURCHASE_REQUESTER,
REPORT_VIEWER,
AUDITOR
​
sendWelcomeEmail
boolean | null

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>
​
companyId
string<uuid>
​
companyEntityId
string<uuid>
​
email
string
​
firstName
string
​
lastName
string
​
phoneNumber
object

Vendor phone number.

​
avatarUrl
string
​
notificationChannel
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
MS_TEAMS,
SLACK,
WEB_APP
​
country
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
UNDEFINED,
AC,
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AN,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BU,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CP,
CR,
CS,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DG,
DJ,
DK,
DM,
DO,
DZ,
EA,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
EZ,
FI,
FJ,
FK,
FM,
FO,
FR,
FX,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
IC,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NT,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SF,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SU,
SV,
SX,
SY,
SZ,
TA,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TP,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UK,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XI,
XU,
XK,
YE,
YT,
YU,
ZA,
ZM,
ZR,
ZW
​
city
string
​
zipcode
string
​
address
string
​
status
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
ACTIVE,
DEACTIVATED
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
roles
enum<string>[]

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
SUPERUSER,
REIMBURSEMENT,
CARDHOLDER,
CONTROLLER,
COMPANY_ADMIN,
VENDOR_MANAGEMENT,
INVOICE_APPROVER,
AP_PREPARATION,
AP_CLERK,
AR_CLERK,
PURCHASE_REQUESTER,
REPORT_VIEWER,
AUDITOR
​
groups
object[]
​
managerIds
string<uuid>[]