Skip to content

Instantly share code, notes, and snippets.

@shash-sgnl

shash-sgnl/BambooHR Employee and Applications Postman Collection.json

Last active January 22, 2024 22:31
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save shash-sgnl/87b47397bff2f6016b7265a2fcc5b4ef to your computer and use it in GitHub Desktop.
Save shash-sgnl/87b47397bff2f6016b7265a2fcc5b4ef to your computer and use it in GitHub Desktop.
Download ZIP
BambooHR Employee Directory Postman Collection and Environment
Raw
BambooHR Employee and Applications Postman Collection.json
{
"info": {
"_postman_id": "cdd72516-2e74-46e3-bd67-c04aee34143e",
"name": "BambooHR - Writing a Custom SGNL Adapter",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "23742644"
},
"item": [
{
"name": "Employees",
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{apiValue}}",
"type": "string"
},
{
"key": "username",
"value": "{{apiKey}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.bamboohr.com/api/gateway.php/{{domainName}}/v1/employees/directory",
"protocol": "https",
"host": [
"api",
"bamboohr",
"com"
],
"path": [
"api",
"gateway.php",
"{{domainName}}",
"v1",
"employees",
"directory"
]
}
},
"response": []
},
{
"name": "Applications",
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "password",
"value": "{{apiValue}}",
"type": "string"
},
{
"key": "username",
"value": "{{apiKey}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.bamboohr.com/api/gateway.php/{{domainName}}/v1/applicant_tracking/applications",
"protocol": "https",
"host": [
"api",
"bamboohr",
"com"
],
"path": [
"api",
"gateway.php",
"{{domainName}}",
"v1",
"applicant_tracking",
"applications"
]
}
},
"response": []
}
]
}
Raw
BambooHR Environment.json
{
"id": "17cf97a4-77ac-4337-b837-8afe9a880f04",
"name": "BambooHR",
"values": [
{
"key": "apiKey",
"value": "<<add your key>>",
"type": "secret",
"enabled": true
},
{
"key": "apiValue",
"value": "RANDOM_STRING",
"type": "secret",
"enabled": true
},
{
"key": "domainName",
"value": "<<add your domainName",
"type": "default",
"enabled": true
}
],
"_postman_variable_scope": "environment",
"_postman_exported_at": "2023-12-13T05:20:16.088Z",
"_postman_exported_using": "Postman/10.20.10-231204-0510"
}
Raw
bamboohr.sgnl.yaml
# BambooHR Configuration YAML
displayName: "BambooHR"
icon: PHN2ZyB3aWR0aD0iNjQiIGhlaWdodD0iNjQiIHZpZXdCb3g9IjAgMCA2NCA2NCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHJlY3Qgd2lkdGg9IjY0IiBoZWlnaHQ9IjY0IiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTM2LjA2MiA0MS44NEMzNS4zMDk2IDQxLjg0NTEgMzQuNTYzNiA0MS43MDA3IDMzLjg2NzQgNDEuNDE1M0MzMy4xNzExIDQxLjEyOTkgMzIuNTM4NSA0MC43MDkxIDMyLjAwNjEgNDAuMTc3M0MzMS40NzM4IDM5LjY0NTUgMzEuMDUyMyAzOS4wMTMzIDMwLjc2NjIgMzguMzE3NEMzMC40OCAzNy42MjE1IDMwLjMzNDkgMzYuODc1NyAzMC4zMzkyIDM2LjEyMzJDMzAuMzM5MiAzMi44NDcyIDMyLjU1MDggMzAuMTU4IDM2LjExNzIgMzAuMTU4QzM5LjY4MzYgMzAuMTU4IDQxLjc4NiAzMy4wMzggNDEuNzg2IDM2LjA2MkM0MS43ODYgMzkuMzUzNiAzOS41NiA0MS44NCAzNi4wNjIgNDEuODRaTTI2LjkyNCAzMS4wMDA0TDI1LjgyODQgMjcuNDEyNEMyNS4xNzU2IDI1LjUyNDggMjQuOTg4NCAyNC40Mzc2IDIzLjE0MDQgMjIuNDkyNEMyMi41MDkyIDIxLjgyNTIgMjAuMTIyNCAyMC4zNTc2IDIwLjQxODggMjAuNjc4QzIzLjQ0NCAyMy45NDMyIDI0Ljk5MDggMjcuOTAwOCAyNS41ODg0IDI5QzI1LjA0IDI4LjMzNTIgMjQuMzk4IDI3LjczNjQgMjMuNjY4NCAyNi45OTM2QzIzLjA5OTQgMjYuMzkzNCAyMi40NjMyIDI1Ljg2MDcgMjEuNzcyNCAyNS40MDZDMjEuMzY0NCAyNS4xNTQgMjEuMTM1MiAyNS4wMTQ4IDIwLjcyMjQgMjQuOEMxOS4zMzA2IDI0LjA3NTIgMTcuODY3NiAyMy40OTYyIDE2LjM1NjggMjMuMDcyQzE1LjgwNDUgMjIuOTQwMiAxNS4yNDI4IDIyLjg1MTUgMTQuNjc2OCAyMi44MDY4QzE0LjY3NjggMjIuODA2OCAxNy4zNzggMjUuMDg2OCAxOC41MzYgMjYuNTM4OEMxOS42OTQgMjcuOTkwOCAyMC44NzM2IDI5LjI5MTYgMjIuMTc5MiAyOS44MjMyQzIzLjQ4NDggMzAuMzU0OCAyMy45Mzg0IDMwLjUwNzIgMjQuOTY1NiAzMC42NjMyQzI1Ljg0NCAzMC44IDI2LjkyNCAzMS4wMDA0IDI2LjkyNCAzMS4wMDA0Wk0zNi4zMTA0IDI3LjgyMTZDMzMuNDU0NCAyNy44MjE2IDMxLjkyMzIgMjguODAyIDMwLjg0OTIgMjkuODYxNkwzMC41NiAzMC4xNzQ4VjIwLjZIMjguMDg4VjM2LjI2OTZDMjguMDg4IDQxLjA5IDMxLjgwMDggNDQuMDkzNiAzNi4wNjIgNDQuMDkzNkM0MC43NTY0IDQ0LjA5MzYgNDQuMzA5NiA0MC40ODE2IDQ0LjMwOTYgMzUuODM4OEM0NC4zMDk2IDMxLjUyNzIgNDAuNjAyOCAyNy44MjE2IDM2LjMxMDQgMjcuODIxNlpNNTYgMzJDNTYgNDUuMjU1MiA0NS4yNTUyIDU2IDMyIDU2QzE4Ljc0NDggNTYgOCA0NS4yNTUyIDggMzJDOCAxOC43NDQ4IDE4Ljc0NDggOCAzMiA4QzQ1LjI1NTIgOCA1NiAxOC43NDQ4IDU2IDMyWiIgZmlsbD0iIzczQzQxRCIvPgo8L3N2Zz4K
description: "BambooHR as a System of Record"
address: "api.bamboohr.com/api/gateway.php/YOUR-BAMBOOHR-DOMAIN"
defaultSyncFrequency: HOURLY
defaultSyncMinInterval: 1
defaultApiCallFrequency: SECONDLY
defaultApiCallMinInterval: 1
type: "BambooHR-1.0.0"
adapterConfig: "ewogICJhcGlWZXJzaW9uIjogInYxIiwKICAiYWNjZXB0SGVhZGVyIjogImFwcGxpY2F0aW9uL2pzb24iCn0K"
auth:
- basic:
username: "YOUR-USERNAME"
password: "BAMBOOHR API KEY"
entities:
# https://documentation.bamboohr.com/reference/get-employees-directory-1
Employee:
displayName: Employee
externalId: directory
description: Employee entity in BambooHR
syncFrequency: HOURLY
syncMinInterval: 1
apiCallFrequency: SECONDLY
apiCallMinInterval: 1
pagesOrderedById: false
attributes:
- name: id
externalId: id
type: String
indexed: true
uniqueId: true
- name: displayName
externalId: displayName
type: String
indexed: true
- name: firstName
externalId: firstName
type: String
- name: lastName
externalId: lastName
type: String
- name: preferredName
externalId: preferredName
type: String
- name: jobTitle
externalId: jobTitle
type: String
indexed: true
- name: workEmail
externalId: workEmail
type: String
- name: department
externalId: department
type: String
indexed: true
- name: location
externalId: location
type: String
- name: division
externalId: division
type: String
indexed: true
- name: supervisor
externalId: supervisor
type: String
indexed: true
Application:
displayName: Application
externalId: applications
description: Application entity in BambooHR
syncFrequency: HOURLY
syncMinInterval: 1
apiCallFrequency: SECONDLY
apiCallMinInterval: 1
pagesOrderedById: false
attributes:
- name: id
externalId: id
type: String
indexed: true
uniqueId: true
- name: appliedDate
externalId: appliedDate
type: DateTime
- name: status
externalId: status__label
type: String
indexed: true
- name: firstName
externalId: applicant__firstName
type: String
- name: lastName
externalId: applicant__lastName
type: String
- name: email
externalId: applicant__email
type: String
- name: jobTitle
externalId: job__title__label
type: String
relationships:
Manager:
name: Manager
fromAttribute: directory.supervisor
toAttribute: directory.displayName
Raw
Postman BambooHR Adapter gRPC request for Applications.json
{
"datasource": {
"address": "https://api.bamboohr.com/api/gateway.php/<YourBambooHRDomain>",
"auth": {
"basic": {
"password": "BambooHR API Key",
"username": "randomstring"
}
},
"config":"ewogICJhcGlWZXJzaW9uIjogInYxIiwKICAiYWNjZXB0SGVhZGVyIjogImFwcGxpY2F0aW9uL2pzb24iCn0K",
"id": "38c96d7c-c042-4823-9337-cf658ad20000",
"type": "BambooHR-1.0.0"
},
"entity": {
"attributes": [
{
"type": "ATTRIBUTE_TYPE_INT64",
"external_id": "id",
"id": "38c96d7c-c042-4823-9337-cf658ad20001",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_DATE_TIME",
"external_id": "appliedDate",
"id": "38c96d7c-c042-4823-9337-cf658ad20002",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "applicant__firstName",
"id": "38c96d7c-c042-4823-9337-cf658ad20003",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "applicant_lastName",
"id": "38c96d7c-c042-4823-9337-cf658ad20004",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "status__label",
"id": "38c96d7c-c042-4823-9337-cf658ad20005",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "applicant__email",
"id": "38c96d7c-c042-4823-9337-cf658ad20006",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "job__title__label",
"id": "38c96d7c-c042-4823-9337-cf658ad20007",
"list": false,
"ordered": false
}
],
"child_entities": [],
"external_id": "applications",
"id": "38c96d7c-c042-4823-9337-cf658ad21000",
"ordered": false
},
"page_size": "100"
}
Raw
Postman BambooHR Adapter gRPC request for Employees.json
{
"datasource": {
"address": "https://api.bamboohr.com/api/gateway.php/<YourBambooHRDomain>",
"auth": {
"basic": {
"password": "BambooHR API Key",
"username": "randomstring"
}
},
"config":"ewogICJhcGlWZXJzaW9uIjogInYxIiwKICAiYWNjZXB0SGVhZGVyIjogImFwcGxpY2F0aW9uL2pzb24iCn0K",
"id": "38c96d7c-c042-4823-9337-cf658ad20000",
"type": "BambooHR-1.0.0"
},
"entity": {
"attributes": [
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "id",
"id": "38c96d7c-c042-4823-9337-cf658ad20001",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "displayName",
"id": "38c96d7c-c042-4823-9337-cf658ad20002",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "firstName",
"id": "38c96d7c-c042-4823-9337-cf658ad20003",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "lastName",
"id": "38c96d7c-c042-4823-9337-cf658ad20004",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "preferredName",
"id": "38c96d7c-c042-4823-9337-cf658ad20005",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "jobTitle",
"id": "38c96d7c-c042-4823-9337-cf658ad20006",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "workEmail",
"id": "38c96d7c-c042-4823-9337-cf658ad20007",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "department",
"id": "38c96d7c-c042-4823-9337-cf658ad20008",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "location",
"id": "38c96d7c-c042-4823-9337-cf658ad20009",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "division",
"id": "38c96d7c-c042-4823-9337-cf658ad20010",
"list": false,
"ordered": false
},
{
"type": "ATTRIBUTE_TYPE_STRING",
"external_id": "supervisor",
"id": "38c96d7c-c042-4823-9337-cf658ad20011",
"list": false,
"ordered": false
}
],
"child_entities": [],
"external_id": "directory",
"id": "38c96d7c-c042-4823-9337-cf658ad21000",
"ordered": false
},
"page_size": "100"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment