Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Calendar
- Chat
- Agents
- Collections
- Displayable Lists
- Documents
- Images
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Tools
- User
- Verification
Actions API
- Authentication
- Setup
Index employee
Adds an employee or updates information about an employee
curl --request POST \
--url https://{domain}-be.glean.com/api/index/v1/indexemployee \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json; charset=UTF-8' \
--data '{
"employee": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"preferredName": "<string>",
"id": "<string>",
"phoneNumber": "<string>",
"location": "<string>",
"structuredLocation": {
"deskLocation": "<string>",
"timezone": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"zipCode": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"title": "<string>",
"photoUrl": "<string>",
"businessUnit": "<string>",
"department": "<string>",
"datasourceProfiles": [
{
"datasource": "github",
"handle": "<string>",
"url": "<string>",
"nativeAppUrl": "<string>",
"isUserGenerated": true
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
],
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"bio": "<string>",
"pronoun": "<string>",
"alsoKnownAs": [
"<string>"
],
"profileUrl": "<string>",
"socialNetworks": [
{
"name": "<string>",
"profileName": "<string>",
"profileUrl": "<string>"
}
],
"managerEmail": "<string>",
"managerId": "<string>",
"type": "FULL_TIME",
"relationships": [
{
"name": "<string>",
"email": "<string>"
}
],
"status": "CURRENT",
"additionalFields": [
{
"key": "<string>",
"value": [
{}
]
}
]
},
"version": 123
}'Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Info about an employee and optional version for that info
Info about the employee
The employee's email
An organizational unit where everyone has a similar task, e.g. Engineering.
The first name of the employee. Note: The value cannot be empty
The last name of the employee. Note: The value cannot be empty
The preferred name or nickname of the employee
[Advanced] A unique universal internal identifier for the employee. This is solely used for understanding manager relationships along with managerId.
The employee's phone number.
The employee's location (city/office name etc).
Detailed location with information about country, state, city etc.
Desk number.
Location's timezone, e.g. UTC, PST.
Office address or name.
Name of the city.
State code.
Region information, e.g. NORAM, APAC.
ZIP Code for the address.
Country name.
Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA.
The employee's role title.
The employee's profile pic
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
The datasource profiles of the employee, e.g. Slack,Github.
The datasource the profile is of.
"github"
The display name of the entity in the given datasource.
URL to view the entity's profile.
A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...).
For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source)
The date when the employee started
If a former employee, the last date of employment.
Short biography or mission statement of the employee.
She/her, He/his or other pronoun.
Other names associated with the employee.
Link to internal company person profile.
The email of the employee's manager
[Advanced] A unique universal internal identifier for the employee's manager. This is solely used in conjunction with id.
The type of the employee, an enum of FULL_TIME, CONTRACTOR, NON_EMPLOYEE
List of unidirectional relationships with other employees. E.g. this employee (A) is a CHIEF_OF_STAFF to another employee (B); or this employee (A) is an EXECUTIVE_ASSISTANT of another employee (C). The mapping should be attached to A's profile.
Describes a relationship edge between a source and destination entity
The title or type of relationship. Currently an enum of CHIEF_OF_STAFF, EXECUTIVE_ASSISTANT
Email of the person with whom the relationship exists. Per the example above, either B or C's email depending on the relationship.
The status of the employee, an enum of CURRENT, FUTURE, EX
List of additional fields with more information about the employee.
Additional information about the employee or team.
Key to reference this field, e.g. "languages". Note that the key should be all lowercase alphabetic characters with no numbers, spaces, hyphens or underscores.
List of type string or HypertextField.
HypertextField is defined as
{
anchor: string, // Anchor text for the hypertext field.
hyperlink: string, // URL for the hypertext field.
}
Example: {"anchor":"Glean","hyperlink":"https://glean.com"}
When OpenAPI Generator supports oneOf, we will semantically enforce this in the docs.
Note: If using the Python SDK to pass in a list of strings, the value may need to be a list of dictionaries. In that case, the key in that dictionary will be ignored.
Example: "languages": [{"lang":"English","lang":"Spanish",...}]. In this case, the key "lang" will be ignored and can even be passed in as an empty string.
Either a string or HypertextField. When OpenAPI Generator supports oneOf, we can semantically enforce this in the docs.
Version number for the employee object. If absent or 0 then no version checks are done
Response
OK
Was this page helpful?
curl --request POST \
--url https://{domain}-be.glean.com/api/index/v1/indexemployee \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json; charset=UTF-8' \
--data '{
"employee": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"preferredName": "<string>",
"id": "<string>",
"phoneNumber": "<string>",
"location": "<string>",
"structuredLocation": {
"deskLocation": "<string>",
"timezone": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"region": "<string>",
"zipCode": "<string>",
"country": "<string>",
"countryCode": "<string>"
},
"title": "<string>",
"photoUrl": "<string>",
"businessUnit": "<string>",
"department": "<string>",
"datasourceProfiles": [
{
"datasource": "github",
"handle": "<string>",
"url": "<string>",
"nativeAppUrl": "<string>",
"isUserGenerated": true
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
],
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"bio": "<string>",
"pronoun": "<string>",
"alsoKnownAs": [
"<string>"
],
"profileUrl": "<string>",
"socialNetworks": [
{
"name": "<string>",
"profileName": "<string>",
"profileUrl": "<string>"
}
],
"managerEmail": "<string>",
"managerId": "<string>",
"type": "FULL_TIME",
"relationships": [
{
"name": "<string>",
"email": "<string>"
}
],
"status": "CURRENT",
"additionalFields": [
{
"key": "<string>",
"value": [
{}
]
}
]
},
"version": 123
}'