1(this["webpackJsonpdevelopers-intellihr-io"]=this["webpackJsonpdevelopers-intellihr-io"]||[]).push([[0],{102:function(e,t,n){e.exports={container:"heading_container__1Zh1B"}},123:function(e,t,n){},136:function(e,t,n){"use strict";n.r(t);var i,s=n(2),r=n.n(s),c=n(53),o=n.n(c),a=(n(123),n(186)),l=n(181),d=n(182),h=n(183),j=n(185),b=n(184),p=n(43),u=n.n(p),x=n(102),m=n.n(x),O=n(0),A=function(){return Object(O.jsxs)("div",{className:m.a.container,children:[Object(O.jsx)("img",{src:"https://assets.intellihr.io/static/images/logos/IntelliHR-on-White-RGB.png",alt:"IntelliHR logo"}),Object(O.jsx)("h1",{children:"Getting Started with the intelliHR API"}),Object(O.jsx)("p",{children:"Welcome! This guide will show you how to get started with the intelliHR public API."})]})},g=n(93),f=n.n(g),v=function(e){var t=e.title,n=e.children,i=e.elRef;return Object(O.jsxs)(l.a,{ref:i,children:[Object(O.jsxs)("h2",{className:f.a.title,children:[t,":"]}),Object(O.jsx)(d.a,{}),Object(O.jsx)("div",{className:f.a.content,children:n})]})},w=n.p+"static/media/model_diagram_2.e38249f4.png",y=n.p+"static/media/model_diagram.7676acdd.png",I=n.p+"static/media/get_access_key.829789b1.gif",P=n.p+"static/media/header_example_with_authorization_and_tenant_insomnia.a9da6c10.png",R=n(33),B=n(177),E=n(178),T=n(103),H=n(188),q=n(176),C=n(189),U=n(190),N=n(180),K=n(107),Q=n.n(K),k=n(174),V=n(84),W=n.n(V),X=Object(B.a)(i||(i=Object(R.a)(["\n query {\n changeLogCollection {\n items {\n date\n content {\n json\n }\n }\n }\n }\n"]))),_=function(){var e=Object(E.a)(X),t=e.data,n=e.error;return e.loading?Object(O.jsx)(N.a,{className:W.a.loading,children:Object(O.jsx)(H.a,{})}):n?Object(O.jsx)(N.a,{className:W.a.error,children:Object(O.jsxs)(k.a,{severity:"error",sx:{width:"100%"},children:["Error: ",n.message]})}):Object(O.jsx)("div",{className:W.a.changeLog,children:t.changeLogCollection.items.slice(0,15).map((function(e){return Object(O.jsxs)(q.a,{children:[Object(O.jsx)(C.a,{expandIcon:Object(O.jsx)(Q.a,{}),children:Object(O.jsx)("h4",{children:e.date.split("T")[0]})}),Object(O.jsx)(U.a,{children:Object(T.documentToReactComponents)(e.content.json)})]},e.date)}))})},z=n(23),L=n(191),M=n(97),F=n.n(M),G=function(e){var t=e.name,n=e.elRef,i=Object(s.useState)(!1),r=Object(z.a)(i,2),c=r[0],o=r[1];return Object(s.useEffect)((function(){var e=function(){var e=window.scrollY>=n.current.offsetTop-1&&!(n.current.scrollHeight+n.current.offsetTop<window.scrollY)&&!(window.scrollY===document.body.clientHeight-window.innerHeight)||window.scrollY===document.body.clientHeight-window.innerHeight&&(n.current.offsetTop>window.scrollY||window.innerHeight<n.current.scrollHeight&&window.scrollY-n.current.offsetTop<1e3);e!==c&&o(e)};return window.addEventListener("scroll",e),function(){window.removeEventListener("scroll",e)}}),[n,c]),Object(O.jsx)(L.a,{className:"".concat(F.a.navButton," ").concat(c?F.a.active:""),onClick:function(){n.current.scrollIntoView()},variant:"text",color:"inherit",fullWidth:!0,children:t})},S=Object(O.jsxs)(O.Fragment,{children:[Object(O.jsxs)("h3",{children:["The latest public API Docs can be found"," ",Object(O.jsx)("a",{href:"".concat(window.location.href,"docs/v1/"),children:"here"})]}),Object(O.jsxs)("p",{children:[Object(O.jsx)("strong",{children:"Version 1 of the intelliHR public API is now released!"})," ","This version can be considered stable and production ready for integrations with third party systems."]}),Object(O.jsx)("p",{children:"Note that future endpoints and data models may be added to this API in the near future, but no breaking changes will be made to any endpoints on v1."}),Object(O.jsx)("p",{children:"If you have any suggestions, feedback or complaints, please contact us at [email protected], and mention that you have an enquiry about our public API and we can put you in touch directly with the development team."})]}),Y=Object(O.jsxs)("div",{children:[Object(O.jsx)("p",{children:"Welcome to the intelliHR API! Our public API will give you access to multiple endpoints, such as the People API (to lookup, list or create a person), or the Jobs API (to retrieve or insert Job related information)."}),Object(O.jsx)("p",{children:"The API is organised around REST. All requests should be made over HTTPS. All request response bodies, including errors are encoded in JSON."}),Object(O.jsxs)("p",{children:["To learn more about the API endpoints, proceed to our"," ",Object(O.jsx)("a",{href:"".concat(window.location.href,"docs/v1/"),children:"API docs"})," page."]}),Object(O.jsxs)("p",{children:["API status and uptime statistics can be found"," ",Object(O.jsx)("a",{href:"http://stats.pingdom.com/fwqaxhft3dij/5148338",target:"_blank",rel:"noreferrer",children:"here"}),"."]}),Object(O.jsx)("p",{children:"The intelliHR API aims to help companies, both customers and partners, to build custom HRIS solutions that can grow and scale within their own industries, existing workflows and processes."}),Object(O.jsxs)("p",{children:["If you are interested in joining our Partnership program or ready to build an integration to intelliHR ",Object(O.jsx)("a",{href:"https://survey-intellihr.typeform.com/to/GhYQ4wBM",children:"please fill out this form to register your intent"}),"."]}),Object(O.jsx)("p",{children:"Once your registration has been accepted we will book a pre-deployment session with our integration team to supp
1ort you throughout the process."})]}),Z=Object(O.jsxs)("div",{children:[Object(O.jsx)("p",{children:"The intelliHR public API limits requests based on the tenant over a period of time. This helps to maintain API integrity and response times for all customers."}),Object(O.jsx)("p",{children:"The public API will always respond with these headers to help manage your API request rate:"}),Object(O.jsxs)("ul",{children:[Object(O.jsxs)("li",{children:[Object(O.jsx)("strong",{children:"Retry-After"}),": Seconds until the limit is reset"]}),Object(O.jsxs)("li",{children:[Object(O.jsx)("strong",{children:"X-RateLimit-Limit"}),": The current request limit."]}),Object(O.jsxs)("li",{children:[Object(O.jsx)("strong",{children:"X-RateLimit-Remaining"}),": Amount of requests remaining before the limit is reached"]}),Object(O.jsxs)("li",{children:[Object(O.jsx)("strong",{children:"X-RateLimit-Reset"}),": The Exact DateTime the limit will reset."]})]}),Object(O.jsxs)("p",{children:["When the limit has been reached the response will return a ",Object(O.jsx)("strong",{children:"HTTP status code of 429"})," and no data."]}),Object(O.jsx)(d.a,{}),Object(O.jsxs)("p",{children:["The current limit is ",Object(O.jsx)("strong",{children:"250 requests per 60 seconds"}),"."]}),Object(O.jsx)("p",{children:"If you would like this limit to be increased, please talk to your Account Manager."})]}),J=Object(O.jsxs)("div",{className:u.a.overview,children:[Object(O.jsx)("p",{children:"Here we will provide find a quick overview of relations between tenants, people, users and jobs."}),Object(O.jsx)("br",{}),Object(O.jsx)("p",{children:Object(O.jsx)("b",{children:"Tenant"})}),Object(O.jsx)("p",{children:"Your company/organisation"}),Object(O.jsx)("p",{children:Object(O.jsx)("b",{children:"Person"})}),Object(O.jsxs)("p",{children:["A person/staff member within your company/organisation.",Object(O.jsx)("br",{}),"People represent the base objects in the intelliHR data model. All past, present and future employees should be created as a Person and then have a Job created which references that Person object."]}),Object(O.jsx)("p",{children:Object(O.jsx)("b",{children:"User Account"})}),Object(O.jsxs)("p",{children:["User accounts give employees access to the application and is linked to an existing Person.",Object(O.jsx)("br",{}),"A Person can exist without a User, as employees can still complete tasks sent to their primary email address."]}),Object(O.jsx)("p",{children:"Currently, User creation is not supported through the intelliHR API, and must be created within the dashboard."}),Object(O.jsx)("p",{children:Object(O.jsx)("b",{children:"Job"})}),Object(O.jsxs)("p",{children:["The Job object is the core data object for past, current and future roles that a Person holds in the organisation.",Object(O.jsx)("br",{}),"Jobs are effective dated, a Person can have more than one Job at a point in time to represent secondment / role sharing."]}),Object(O.jsx)("br",{}),Object(O.jsx)("p",{children:Object(O.jsx)("i",{children:"Relation Diagram"})}),Object(O.jsx)("img",{src:w,alt:"Relation Diagram"}),Object(O.jsx)("br",{}),Object(O.jsx)("br",{}),Object(O.jsx)("p",{children:Object(O.jsx)("i",{children:"Model Diagram"})}),Object(O.jsx)("img",{src:y,alt:"Model Diagram"})]}),D=Object(O.jsxs)("div",{className:u.a.authentication,children:[Object(O.jsx)("p",{children:"intelliHR is using a string based authentication token for API request authorisation. In order to use the intelliHR API, you will have to send a token generated for your organisation with every request. Here is how you can obtain one for your system:"}),Object(O.jsxs)(h.a,{children:[Object(O.jsx)(b.a,{component:"img",image:I,alt:"Get API Access Key"}),Object(O.jsx)(j.a,{children:Object(O.jsxs)("ol",{children:[Object(O.jsx)("li",{children:"Use your intelliHR credentials to login to the intellihr platform."}),Object(O.jsx)("li",{children:"Using the main menu on your left, go to: Settings."}),Object(O.jsx)("li",{children:"Under the settings menu, go to: Public Api Access Keys."}),Object(O.jsx)("li",{children:"Click Create Access Key button."}),Object(O.jsx)("li",{children:"When prompted, enter a name for the Access Key."}),Object(O.jsx)("li",{children:"Copy the generated Access Key somewhere safe. (Keep in mind that you won't be able to regenerate the same Access Key again, so make sure you save it.)"})]})})]}),Object(O.jsx)("p",{children:"You can now send API requests to intelliHR using the generated Access Key. Note that currently there is no support for permission scopes - any API token can access all endpoints and should be considered the same as full system administrator access. Please email us at [email protected] to tell us about your use case for permission scoped tokens!"})]}),$=Object(O.jsxs)("div",{className:u.a.usage,children:[Object(O.jsxs)("p",{children:["To quickly test your access tokens and get familiar with the API, we recommend using ",Object(O.jsx)("a",{href:"https://insomnia.rest/",children:"insomnia"})," to try and send some test API requests. Take a look at an example below."]}),Object(O.jsxs)("ol",{children:[Object(O.jsxs)("li",{children:["Download our OpenAPI Specification ",Object(O.jsx)("code",{children:"swagger.json"})," by visiting"," ",Object(O.jsx)("a",{href:"".concat(window.location.href,"docs/v1/"),children:"here."})]}),Object(O.jsxs)("li",{children:["Import ",Object(O.jsx)("code",{children:"swagger.json"})," file to Insomnia.",Object(O.jsxs)("ul",{children:[Object(O.jsx)("li",{children:'Select "Import/Export" by clicking "Insomnia" icon on top left.'}),Object(O.jsxs)("li",{children:['In "Data" tab, select "Import Data" => "From File" and select',Object(O.jsx)("code",{children:"swagger.json"})," file."]}),Object(O.jsx)("li",{children:'Select "New Workspace" in the popup window.'})]})]}),Object(O.jsxs)("li",{children:["Configure the environment.",Object(O.jsxs)("ul",{children:[Object(O.jsx)("li",{children:'In the newly created workspace, click "No Environment" tab to select "Manage Environments".'}),Object(O.jsx)("li",{children:'In "OpenAPI env", replace the prepopulated value for "apiKey" with your own API access key with "bearer" as a prefix.'}),Object(O.jsxs)("li",{children:['In "OpenAPI env", add "tenant" key value pair. "tenant" is your organisation tenant name which will be the subdomain part of your application URL for example:'," ",Object(O.jsx)("code",{children:"https://<tenant>.intellihr.net"})]}),"You will have the following environment variables in the end."]}),Object(O.jsx)("pre",{children:Object(O.jsx)("code",{children:' {\n "tenant": "<your-organisation-tenant-name>",\n "apiKey": "bearer <your-own-secret-api-key>",\n "base_path": "/v1",\n "host": "api.intellihr.io",\n "scheme": "https"\n }'})})]}),Object(O.jsx)("li",{children:'Click "No Environment" tab and select "Use OpenAPI env" to apply the configured environment setting.'}),Object(O.jsxs)("li",{children:["Make a request.",Object(O.jsxs)("ul",{children:[Object(O.jsxs)("li",{children:['Go to "People" section on the left side bar and select'," ",Object(O.jsx)("code",{children:"List all people"})," request.",Object(O.jsx)("img",{src:"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAWUAAACOCAYAAADpcRlOAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAAxISURBVHhe7d3fjxXlHcfx/jMmbUj0ogZbEjVaTaWQ3qhU2oryq4pYQS1qWUv3ompZwCXtFrJQIUHTUpuaUts0alBTFCERKBhCYlDoXXvVXnr31M9svofvPvvM7J7dc858Ofu+eGXPzPPMM3O2yZvxgaRfufGmJQkA0K5v33N3+urXbkhEGQACIMoAEAhRBoBAiDIABEKUASAQogwAgRBlAAiEKANAIEQZAAIhygAQCFEGgECIMgAEQpQBIJB5RfmHD34/bdn648rmxzelO++8vTgPANCdrqO8a9fO9Omnn6arV692fPTRyXT/qnuL8wEAc9d1lI8d+/O0IIsiffTo79Phw4c6XnzxF+mWb9xcXKNNev4TJ/5RHAOAtvUkyiVXrlxJr//xD8U1zMGDB6Zdc/ny5bRz50vFub1ClAFE1rcoy2zxU5T9HB1funSp2qv283qJKAOIbEFR1tvwyZMn06uvHZm2dWF27x4rrmHyKOsvEE+dOtV5W/b3ykOqYxvzIde1Fy5cqN7SS9fmUW66BwAM2ryjrH3kvXtfTgcOTqZ333s3vf/+e7Xeeeft4ttvU5Q1dubMmeqcxjRP99Zn/fRjfq6u1TaIratzGvPX2ljTPQCgDfOK8meffZYOHX6l+qy3ZXvTrKMwr1i5fMZaeZS1niK54+c/q35qPJ+ruOtN2O89K6oWc3tT9n8I+PhalC3WpXvYMQAMWtdRfuONP1VBls8//7wYYe/jMx+nteseKq6lCPq5Fk4Lph+z8d17dlU/8zdvxVTrlaKsc4p2Kcqle2jMrw0Ag9J1lJ98aku1V5z/W+WSixcvpmef3VZcR+reTBVFv7fszfdN2e7jo1x3DwBoS9dR3vij9en8+fPFCBttaZw7dy7t2PF8cQ3TtF1gWxmlt1Zd48e0jh0rstpT1vUaU5z1F4Gao2OLsn3mzRhAJF1HuZeaoiwa87G3sOZjPqz2pnz8+PHOuAVafJTzdcTfAwAGrdUo90Np+wIArhdEGQACIcoAEMjQRRkArmdEGQACIcoAEAhRBoBAiDIABEKUASAQogwAgRBlAAiEKANAIEQZAALpRHnpLTcnAEC7iDIABEKUASAQogwAgRBlAAiEKANAIEQZAAIhygAQCFEGgECIMgAEQpQBIBCiDACBEOUaH3zwQaU0tlBv/vXNztp79uxOn3zySfrJtqdnzGuDnkPPo+cqjQPor0UfZQVSSmOzUVjncy1RBlCHKBPlaYgy0K5WonznHcvT/l/+Kx3dlyqHx/+XVi7/QVrzwEh67ddfdM4/tenwtHmicc0rrTsfdVH2wVWoLl26lK5evZouX76cjhw5ks6ePVsdi8ZKUdX1pTlzjbLNE1vn0KFXOuP5c/mQ6rPO2XX+OzatqzXzKPt5fh0AU+5fdV/avv2naWRk+wxrHnqweE2dgUdZ8VWEH98wMWNMsX3uiddnnFfEXx79Z3VtPrZQikwpNAqRzq9bv7YKsI9hPic/L7rurbffqn7q2CKoz7rGPs8WZR9MzVWE9TN/Lr+OxdrG8rlN6+ZR9s/a9LsAFrOHH16T9u/fnyYnJ6fRuUc3PVK8ps7Ao7zj6b9VSmMRo5x
1/rpszG4XM4qZr7LOPqZ+fzzN2T62nQFr09fP06dPVeqXr6u5vbF0f5TzQdq34awHMDLM+P/bYpuLcJgOPsqJr2w+2XWFbEnacb1O0HWV7Q8z/893PKVEI7T/7pRTFbqOsc5KvbXTe5vjrdB9FW9+lad08yrY94uXXAphiYZ5vkKWVN+V862Ln8x91ohzxTdnk//lemmM0x7/J6thipmvsc7dR1rHW8uvlStfV3d/YunmU9R1KzwagbPXq76X1G9YVx+ailT3lg7v/03kLluslyvn5ujmi8z58+mzHfmy2KPu/wFM09eaqueL3jT3N13U2lv9hMtu6FmWN+ecG0H8Dj7IovrZNIQpu6bztPfc7yvl/nitSCpHG/NaF+EBZ/Cxoft3SdXZtN1HWloOt40Mqdn+7h+bZm3k+5uPdtG4e5fx75M8AoLdaiTLmxse7l/q1LoCFI8qBEWVg8SHKgRFlYPEhygAQCFEGgECIMgAEQpQBIBCiDACBEGUACIQoA0AgnSjfeNOSBABoF1EGgECIMgAEQpQBIBCiDACBEGUACIQoA0AgRBkAAiHKABAIUQaAQIgyAARClAEgEKIcxK23LUtjY2NpxcrlxXEAiwNRdkZGtqcHVq8qjvUbUQYgA4/yrd9dkp47sSTtODdl7W+ujemznR85vSR955FrY5tfn37NfduvHRvNsfndUhRfeOGF6mdpvN+IMgBpJcobfjv1eentUyHVOYXWR1Xnnvr71E8F2MfbaxrrxmObN1X0WW/MW5/cUkV6cnIyTUxMTIulAjo+Pl4c02ed05jYmtK0bh7lpnsAGF6tRlkeffXLsI5MBVmR9nMtuHpj3nJs5rifk5/vxtKlX0+jo6Od8CmePoTa0lAgFUrNVVRtm0NzFFONWUhtLJ/btK5YlJvuoWMAw6vVKNvb8PIvo+tDbXxwFWZtaeRbFL2IsuKnYNqxPvs3XB9J0WedszELuq7x64hfu2ldH+Wme9i1AIZTq3vKtm+sc01vyvk5H+ZeRFmxVAj9sY+nnyO2NeHpvK7Jr1NIFVSFtWndPMp19/DXAhg+rW9fGIXVx1ax3nZ8ar6flwd8oVFWDPVW6rcG8nj6N1WFUeM25umafMzPb1o3j3LdPQAMtzBRFsXW/iWF3qYtyAqvnc//VcZCo6xIlt5eba/X5th2gs75fWNPQdWesY1pvm1P6Hi2dS3KTfcAMNwGHuVI/JuqP694PvPMtiqM2jbwIRWLr20r+P3ffMyHtWldH+XZ7gFgeC3qKCuYpW0CncvfnnuhX+sCGB6LOsqKZGmLgCgDaMuijnIdogygLUQZAAIhygAQCFEGgECIMgAEQpQBIBCiDACBEGUACIQoA0AgRBkAAiHKABAIUQaAQIgyAARClAEgEKIMAIEQZQAIhCgDQCBEGQACIcoAEAhRBoBAiHIN/X/pzff/1r/u/yV7GOn3tFi+KzAIiz7Kisrk5GTHxMREWrFyeXHuXPUiylqj18/VD72Isv7gGx0d7Xy//LvLfP+ABK43rUR52TfvSPteupKO7kuVwy//N939rfvS6nu3pdd+9UXn/BMbD0ybJxrXvNK686GoSGlsvnoVZb+GjsfHx9Otty2bNq9t/YpyvqbuE/UPJqCXBh5lxVcRfuSh8Rljiu22zb+bcV4R373jbHVtPrZQdVH2sVEIxsbG0oaN6ztvbv4ahVLB1Hn91Ly6UGktxcXWUYBK8/Iw5eHSWP4seg4959Ynt3TO+2fzUfPnxd9rtu/r2e/JP499J/3M33A1L19rLlEWu1d+HhgmA4/y81v/UimNRY6yguaP9+7dW/1UUBQeC5HFri4eCp2Pj+bqmnxeHiYfLv9s/v75vfNn82vpvP/eusaOm76vzTe6xofYz9XzKO52nY513/z7+u+m4/y7G41rvdLvCxgWA4+yomvbD7ZdYVsSdpxvU/Q7yvaGJxZJH748Bj52os86Z2vWRSVXFynJ19DzaO5dd90xLXQ2JlonH9MaGrNjKT2zrlEYda7p+9p8439Pxt9Tn+26ut+L1p9LlJt+X8CwaOVNOd+6eGn7h50oR96+8DGw2JQCUhcV0Rp+26DpTdn/YWERza83up/G8ihbUDXHvmfp+XStBa/p+/prxP+e/LnSverWmGuUNW5/cORjwLBoZU/54K5/d96C5XqPsgWzdK2XR9OHMJ9bF6ama/L1PYtz3TP74DV9Xzs2pe/q52o9Ha9YcU/tc2vOXKKsc6X/rYBhMvAoi+Jr2xSi4JbO295z5CjrnN5cLUJ2XIpKvo6uaXpTLq0hOl8a0zp1URZdo+9lz+i/t43pc7dR9n+BWPpO9rv09/PmEmUd53+QAMOolShHolCUYmEh0efZIqVx+xcVClLTv77QurbloMjUvT02RVlh0nW2jkVR6/go5/P8epqrZ7Ux/zuY7ft6uk5Btfv4QBsd1/1FoZSibM9Vej5gmC36KKP/FFvbGimNA7iGKKPv6t6yAcxElNE3tg1Rtw0DYCaiDACBEGUACIQoA0AgRBkAAiHKABAIUQaAQIgyAARClAEgEKIMAIEQZQAIhCgDQCBEGQACIcoAEAhRBoBApqJ8Q/o/JRpEFiihl1QAAAAASUVORK5CYII=",alt:"List all people in Insomnia"})]}),Object(O.jsxs)("li",{children:['In the "Header" tab, put the ',Object(O.jsx)("code",{children:"tenant"})," value by selecting from the environment variable list (and notice"," ",Object(O.jsx)("code",{children:"Authorization"})," is already populated).",Object(O.jsx)("img",{src:P,alt:"Header example in Insomnia"})]})]})]})]}),Object(O.jsx)("p",{children:"After you send this request you should be getting a response that follows the following format:"}),Object(O.jsx)(d.a,{}),Object(O.jsx)("pre",{children:Object(O.jsx)("code",{children:'{\n "meta": {\n "pagination": {\n "count": 10,\n "current_page": 1,\n "per_page": 10,\n "total": 306,\n "total_pages": 31\n }\n },\n "links": {\n "self": "http://api.intellihr.io/v1/people?limit=10&page=1",\n "first": "http://api.intellihr.io/v1/people?limit=10&page=1",\n "next": "http://api.intellihr.io/v1/people?limit=10&page=2",\n "last": "http://api.intellihr.io/v1/people?limit=10&page=31"\n },\n "data": [\n {\n "id": "00000000-0000-0000-0000-000000000000",\n "displayName": "Bruce (Batman) Wayne",\n "firstName": "Bruce",\n "middleName": "Thomas",\n "lastName": "Wayne",\n "preferredName": "Batman",\n "dateOfBirth": "1939-07-23",\n "gender": "Male",\n "employeeNumber": "00000",\n "autoIncrementingIntellihrId": 1234,\n "title": "Mr",\n "emergencyContact": {\n "name": "Selina Kyle",\n "relationship": "Colleague",\n "phone": "00 0000 0000",\n "email": "[email protected]"\n },\n "employmentStatus": "Current Staff",\n "jobs": [\n {\n "id": "00000000-0000-0000-0000-000000000000",\n "name": "Software Engineer",\n "startDate": "2003-02-11T14:00:00+00:00",\n "endDate": "2017-02-11T14:00:00+00:00",\n "jobStatus": "Current Job",\n "link": "http://api.intellihr.io/v1/jobs/00000000-0000-0000-0000-000000000000"\n }\n ],\n "primaryEmailAddress": "[email protected]",\n "createdAt": "2019-08-28T04:32:20+00:00",\n "updatedAt": "2019-08-28T04:32:20+00:00"\n },\n ... 9 more records of "type": "people" ...\n ]\n}'})}),Object(O.jsx)(d.a,{}
1),Object(O.jsxs)("p",{children:["Note how every request will return ",Object(O.jsx)("code",{children:"meta"})," and"," ",Object(O.jsx)("code",{children:"links"})," attributes with pagination specific information."]}),Object(O.jsxs)("p",{children:["The ",Object(O.jsx)("code",{children:"links"})," section will provide you with pagination links, however ",Object(O.jsx)("code",{children:"prev"})," and ",Object(O.jsx)("code",{children:"next"})," pages may not always be displayed. For instance, in the example above ",Object(O.jsx)("code",{children:"prev"})," page is not provided, because the current page displayed is the first one. Similarly, when you hit the last page, the API will not provide you with a link to the ",Object(O.jsx)("code",{children:"next"})," page."]}),Object(O.jsxs)("p",{children:["To see the full API documentation please go to our"," ",Object(O.jsx)("a",{href:"".concat(window.location.href,"docs/v1/"),children:"API docs"})," page."]})]}),ee=Object(O.jsxs)("div",{className:u.a.examples,children:[Object(O.jsx)("p",{children:"Below are examples of programmatic API calls."}),Object(O.jsxs)("ul",{children:[Object(O.jsxs)("li",{children:[Object(O.jsx)("h4",{children:"JavaScript"}),Object(O.jsx)(d.a,{}),Object(O.jsx)("pre",{children:Object(O.jsx)("code",{children:"\nfetch('http://api.intellihr.io/v1/people', {\n method: 'GET',\n headers: {\n Authorization: 'Bearer your-secret-access-token',\n Tenant: 'your-organisation-tenant-name',\n },\n})\n .then(\n function(response) {\n jsonFormatterResponse = response.json();\n\n console.log(jsonFormatterResponse);\n }\n );\n "})}),Object(O.jsx)(d.a,{})]}),Object(O.jsxs)("li",{children:[Object(O.jsx)("h4",{children:"Python"}),Object(O.jsx)(d.a,{}),Object(O.jsx)("pre",{children:Object(O.jsx)("code",{children:"\nimport urllib.request\n\nurl = 'http://api.intellihr.io/v1/people'\nheaders = {\n 'Authorization': 'Bearer your-secret-access-token',\n 'Tenant': 'your-organisation-tenant-name'\n}\nreq = urllib.request.Request(url, None, headers)\n\nwith urllib.request.urlopen(req) as response:\n list_of_people_result = response.read()\n print(list_of_people_result)\n "})})]}),Object(O.jsx)(d.a,{}),Object(O.jsxs)("li",{children:[Object(O.jsx)("h4",{children:"Curl"}),Object(O.jsx)(d.a,{}),Object(O.jsx)("pre",{children:Object(O.jsx)("code",{children:'\ncurl \\\n -H "Authorization: Bearer your-secret-access-token" \\\n -H "Tenant: your-organisation-tenant-name" \\\n https://api.intellihr.io/v1/people\n '})}),Object(O.jsx)(d.a,{})]})]}),Object(O.jsxs)("p",{children:["To see the full API documentation please go to our"," ",Object(O.jsx)("a",{href:"".concat(window.location.href,"docs/v1/"),children:"API docs"})," page."]})]}),te=function(){var e=Object(s.useRef)(null),t=Object(s.useRef)(null),n=Object(s.useRef)(null),i=Object(s.useRef)(null),r=Object(s.useRef)(null),c=Object(s.useRef)(null),o=Object(s.useRef)(null);return console.log(window.location),Object(O.jsxs)(a.a,{className:u.a.container,maxWidth:"lg",children:[Object(O.jsx)(A,{}),Object(O.jsx)(l.a,{className:u.a.alert,children:S}),Object(O.jsxs)("div",{className:u.a.contentBox,children:[Object(O.jsxs)(l.a,{className:u.a.navigation,children:[Object(O.jsx)(G,{name:"Introduction",elRef:e}),Object(O.jsx)(d.a,{}),Object(O.jsx)(G,{name:"Overview",elRef:t}),Object(O.jsx)(d.a,{}),Object(O.jsx)(G,{name:"Authentication",elRef:i}),Object(O.jsx)(d.a,{}),Object(O.jsx)(G,{name:"Rate Limits",elRef:n}),Object(O.jsx)(d.a,{}),Object(O.jsx)(G,{name:"Usage",elRef:r}),Object(O.jsx)(d.a,{}),Object(O.jsx)(G,{name:"Examples",elRef:c}),Object(O.jsx)(d.a,{}),Object(O.jsx)(G,{name:"Change Log",elRef:o})]}),Object(O.jsxs)("div",{className:u.a.content,children:[Object(O.jsx)(v,{title:"Introduction",elRef:e,children:Y}),Object(O.jsx)(v,{title:"Overview",elRef:t,children:J}),Object(O.jsx)(v,{title:"Authentication",elRef:i,children:D}),Object(O.jsx)(v,{title:"Rate Limits",elRef:n,children:Z}),Object(O.jsx)(v,{title:"Usage",elRef:r,children:$}),Object(O.jsx)(v,{title:"Examples",elRef:c,children:ee}),Object(O.jsx)(v,{title:"Change Log",elRef:o,children:Object(O.jsx)(_,{})})]})]})]})};var ne=function(){return Object(O.jsx)("div",{children:Object(O.jsx)(te,{})})},ie=n(172),se=n(173),re=n(171),ce=new ie.a({cache:new se.a,uri:"https://graphql.contentful.com/content/v1/spaces
1/".concat("cslkxwfvvwg6"),headers:{Authorization:"Bearer ".concat("nW1ZCP5qqhqsxIUUxTVO3zeh2g2et0qiM8RgygcL_ok")}});o.a.render(Object(O.jsx)(r.a.StrictMode,{children:Object(O.jsx)(re.a,{client:ce,children:Object(O.jsx)(ne,{})})}),document.getElementById("root"))},43:function(e,t,n){e.exports={container:"home_container__g35J3",alert:"home_alert__rcLbg",contentBox:"home_contentBox__3LiYL",navigation:"home_navigation__2sDQF",content:"home_content__UCOVS",overview:"home_overview__3ITC7",authentication:"home_authentication__yP_2T",usage:"home_usage__2KITW",examples:"home_examples__3YnFT"}},84:function(e,t,n){e.exports={changeLog:"changeLog_changeLog__3avPY",loading:"changeLog_loading__2vVO0",error:"changeLog_error__3PaIb"}},93:function(e,t,n){e.exports={title:"section_title__DLHOs",content:"section_content__3bs1w"}},97:function(e,t,n){e.exports={navButton:"navButton_navButton__39IPw",active:"navButton_active__2VYIe"}}},[[136,1,2]]]); 2//# sourceMappingURL=main.4f28b31d.chunk.js.map
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.