Skip to main content
GET
/
users
Get Users
curl --request GET \
  --url https://api.neobrain.io/{version}/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 0,
    "employeeId": "ABC12345",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "secondaryEmail": "[email protected]",
    "phone": "+33 6 12 34 56 78",
    "secondaryPhone": "+33 6 12 34 56 78",
    "gender": 1,
    "locale": "fr",
    "birthDay": "2007-06-23",
    "nationality": "FR",
    "address": "16 Rue de Triomphe",
    "city": "Paris",
    "zipcode": 75015,
    "country": "France",
    "status": 1,
    "isManager": 1,
    "managerId": 123,
    "managerEmployeeId": "ABC0000",
    "job": [
      {
        "id": 0,
        "externalId": "ABC",
        "title": "Java Developer"
      }
    ],
    "additionalFields": [
      {
        "externalFieldId": "external_field_code",
        "name": "Field Name",
        "value": "2007-06-23"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

API token for the Authorization header parameter.

Query Parameters

​
limit
integer

The numbers of results to be displayed on a single page. Default is 10. Maximum value cannot be higher than 50.

​
page
integer

The page number to be displayed when multiple pages are available

Response

200 - application/json

Success

​
id
integer

Internal ID

Example:

0

​
employeeId
string
Example:

"ABC12345"

​
firstName
string
Example:

"John"

​
lastName
string
Example:

"Doe"

​
email
string
​
secondaryEmail
string
​
phone
string
Example:

"+33 6 12 34 56 78"

​
secondaryPhone
string
Example:

"+33 6 12 34 56 78"

​
gender
integer
Example:

1

​
locale
string
Example:

"fr"

​
birthDay
string
Example:

"2007-06-23"

​
nationality
string
Example:

"FR"

​
address
string
Example:

"16 Rue de Triomphe"

​
city
string
Example:

"Paris"

​
zipcode
string
Example:

75015

​
country
string
Example:

"France"

​
status
boolean | null
Example:

1

​
isManager
boolean | null
Example:

1

​
managerId
integer

Manager Internal user ID

Example:

123

​
managerEmployeeId
string

Manager Employee ID

Example:

"ABC0000"

​
job
object[]
​
additionalFields
object[]