Versioning

When we make backwards-incompatible changes to the API, we release new, dated versions.
The current version is 20161108.

To set the API version on a specific request, send a X-Api-Version header. See the API changelog to see current and old versions.

The X-Api-Version header is required when making requests to the API

Successful API requests will have the used API version in the response header X-Api-Version

Rate Limit

Headers

X-Rate-Limit-Limit
# The number of allowed requests in the current period
X-Rate-Limit-Remaining
# The number of remaining requests in the current period
X-Rate-Limit-Reset
# The number of seconds left in the current period

The headers are already present in every response but contains static values. Please use common sense when making requests to the API until it returns real rate limit values.

{"data":[{"id":"1337","type":"answers","links":{"self":"https://api.teamtailor.com/v1/answers/1337"},"attributes":{"boolean":null,"choices":[],"updated-at":"2015-06-21T16:38:51.958+02:00","range":null,"text":"Dear Sir/Madam…","video-token":null},"relationships":{"question":{"links":{"self":"https://api.teamtailor.com/v1/answers/1337/relationships/question","related":"https://api.teamtailor.com/v1/answers/1337/question"}},"candidate":{"links":{"self":"https://api.teamtailor.com/v1/answers/1337/relationships/candidate","related":"https://api.teamtailor.com/v1/answers/1337/candidate"}}}},{"id":"1338","type":"answers","links":{"self":"https://api.teamtailor.com/v1/answers/1338"},"attributes":{"boolean":null,"choices":[],"updated-at":"2015-06-21T16:39:52.181+02:00","range":null,"text":"To Whom It May Concern…","video-token":null},"relationships":{"question":{"links":{"self":"https://api.teamtailor.com/v1/answers/1338/relationships/question","related":"https://api.teamtailor.com/v1/answers/1338/question"}},"candidate":{"links":{"self":"https://api.teamtailor.com/v1/answers/1338/relationships/candidate","related":"https://api.teamtailor.com/v1/answers/1338/candidate"}}}}],"meta":{"record-count":100,"page-count":10},"links":{"first":"https://api.teamtailor.com/v1/answers?page%5Bnumber%5D=1&page%5Bsize%5D=10","next":"https://api.teamtailor.com/v1/answers?page%5Bnumber%5D=2&page%5Bsize%5D=10","last":"https://api.teamtailor.com/v1/answers?page%5Bnumber%5D=10&page%5Bsize%5D=10"}}

Use this endpoint to retrieve lists of answers.

Example parameters

Parameter

Default

Description

include

null

Comma separated list of relations to include in the response. For example candidate,question.

The relations question and candidate are required to be able to create a new answer.
If the candidate already has answered the question, the answer will be updated.

Candidates

Required scope: Admin

A candidate is defined by a unqiue email adress. If a candidate don’t have any job-applications it can be either sourced or connected

When sourced the candidate was added to the system by a recruiter.

A candidate that is connected has opted in to recieve new job notifications and has also the option to create a richer and more personal profile.

Candidate Object

{"data":{"id":"1337","type":"candidates","links":{"self":"https://api.teamtailor.com/v1/candidates/1337"},"attributes":{"connected":true,"created-at":"2017-01-18T21:04:56.178+01:00","email":"john.doe@example.com","facebook-id":null,"first-name":"John","last-name":"Doe","linkedin-uid":null,"linkedin-url":null,"phone":"0700000000","picture":"https://image.jpg","pitch":"I like turtles","referring-site":"Facebook","referring-url":"http://facebook.com/page","resume":"https://s3.amazonaws.com/resume.pdf","sourced":false,"unsubscribed":false,"updated-at":"2017-01-18T21:20:16.646+01:00","facebook-profile":null,"linkedin-profile":null,"tags":[]},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/department","related":"https://api.teamtailor.com/v1/candidates/1337/department"}},"role":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/role","related":"https://api.teamtailor.com/v1/candidates/1337/role"}},"job-applications":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/job-applications","related":"https://api.teamtailor.com/v1/candidates/1337/job-applications"}},"questions":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/questions","related":"https://api.teamtailor.com/v1/candidates/1337/questions"}},"answers":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/answers","related":"https://api.teamtailor.com/v1/candidates/1337/answers"}},"locations":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/locations","related":"https://api.teamtailor.com/v1/candidates/1337/locations"}}}}}

{"data":{"id":"1337","type":"candidates","links":{"self":"https://api.teamtailor.com/v1/candidates/1337"},"attributes":{"connected":true,"created-at":"2017-01-18T21:04:56.178+01:00","email":"john.doe@example.com","facebook-id":null,"first-name":"John","last-name":"Doe","linkedin-uid":null,"linkedin-url":null,"phone":"0700000000","picture":"https://image.jpg","pitch":"I like turtles","referring-site":"Facebook","referring-url":"http://facebook.com/page","resume":"https://s3.amazonaws.com/resume.pdf","sourced":false,"unsubscribed":false,"updated-at":"2017-01-18T21:20:16.646+01:00","facebook-profile":null,"linkedin-profile":null,"tags":[]},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/department","related":"https://api.teamtailor.com/v1/candidates/1337/department"}},"role":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/role","related":"https://api.teamtailor.com/v1/candidates/1337/role"}},"job-applications":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/job-applications","related":"https://api.teamtailor.com/v1/candidates/1337/job-applications"}},"questions":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/questions","related":"https://api.teamtailor.com/v1/candidates/1337/questions"}},"answers":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/answers","related":"https://api.teamtailor.com/v1/candidates/1337/answers"}}}}}

{"data":{"id":"1337","type":"candidates","links":{"self":"https://api.teamtailor.com/v1/candidates/1337"},"attributes":{"connected":true,"created-at":"2017-01-18T21:04:56.178+01:00","email":"john.doe@example.com","facebook-id":null,"first-name":"David","last-name":"Doe","linkedin-uid":null,"linkedin-url":null,"phone":"0700000000","picture":"https://image.jpg","pitch":"I like turtles","referring-site":"Facebook","referring-url":"http://facebook.com/page","resume":"https://s3.amazonaws.com/resume.pdf","sourced":false,"unsubscribed":false,"updated-at":"2017-01-18T21:20:16.646+01:00","facebook-profile":null,"linkedin-profile":null,"tags":[]},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/department","related":"https://api.teamtailor.com/v1/candidates/1337/department"}},"role":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/role","related":"https://api.teamtailor.com/v1/candidates/1337/role"}},"job-applications":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/job-applications","related":"https://api.teamtailor.com/v1/candidates/1337/job-applications"}},"questions":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/questions","related":"https://api.teamtailor.com/v1/candidates/1337/questions"}},"answers":{"links":{"self":"https://api.teamtailor.com/v1/candidates/1337/relationships/answers","related":"https://api.teamtailor.com/v1/candidates/1337/answers"}}}}}

Change a candidates attributes/relationships.

Departments

Department Object

{"data":{"id":"337","type":"departments","links":{"self":"https://api.teamtailor.com/v1/departments/337"},"attributes":{"name":"Product Developments","people-headline":"hello people","people-text":"<p>this is us</p>","row-order":-4194303,"headline":"Building the future.","text":"We know how to build great products. We have built products used by over 5000 companies in the nordics. We are a small team of senior and junior product builders. We live and breath Ruby on rails. We are always looking for smart & fun people so don't be a stranger. Contact us today.","pictures":[{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,f_auto,g_faces:center,h_465,q_80,w_930/v1422365162/f3kp2yz3wickhtqrb50s.jpg"}]},"relationships":{"roles":{"links":{"self":"https://api.teamtailor.com/v1/departments/337/relationships/roles","related":"https://api.teamtailor.com/v1/departments/337/roles"}}}}}

{"data":[{"id":"337","type":"departments","links":{"self":"https://api.teamtailor.com/v1/departments/337"},"attributes":{"name":"Product Developments","people-headline":"hello people","people-text":"<p>this is us</p>","row-order":-4194303,"headline":"Building the future.","text":"We know how to build great products. We have built products used by over 5000 companies in the nordics. We are a small team of senior and junior product builders. We live and breath Ruby on rails. We are always looking for smart & fun people so don't be a stranger. Contact us today.","pictures":[{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,f_auto,g_faces:center,h_465,q_80,w_930/v1422365162/f3kp2yz3wickhtqrb50s.jpg"}]},"relationships":{"roles":{"links":{"self":"https://api.teamtailor.com/v1/departments/337/relationships/roles","related":"https://api.teamtailor.com/v1/departments/337/roles"}}}},{"id":"338","type":"departments","links":{"self":"https://api.teamtailor.com/v1/departments/338"},"attributes":{"name":"Sales and stuff","people-headline":"","people-text":"","row-order":1572865,"headline":"Users, users & users.","text":"Our objective is to identify and convert HR/Marketing professionals to become Teamtailor users. The good thing is that we know we are selling a great product, makes our jobs fun. We don't believe in sell as hell at all cost. Its about educating our users and once they understand the power of the webb/social media they want to become users. Join us.","pictures":[{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,f_auto,g_faces:center,h_465,q_80,w_930/v1422369190/mqv02tchequezical6ue.jpg"}]},"relationships":{"roles":{"links":{"self":"https://api.teamtailor.com/v1/departments/338/relationships/roles","related":"https://api.teamtailor.com/v1/departments/338/roles"}}}},{"id":"339","type":"departments","links":{"self":"https://api.teamtailor.com/v1/departments/339"},"attributes":{"name":"Marketing & PR","people-headline":"","people-text":"","row-order":7340032,"headline":"Spread the word.","text":"Do you want to help us spread the word of modern & effective recruting? We are on to something but we need others to know it as well. Help us make the HR/Marketing world a happier place!","pictures":[{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,f_auto,g_faces:center,h_465,q_80,w_930/v1422370235/mbdlqjzneliyy0l5kcjn.jpg"}]},"relationships":{"roles":{"links":{"self":"https://api.teamtailor.com/v1/departments/339/relationships/roles","related":"https://api.teamtailor.com/v1/departments/339/roles"}}}}],"meta":{"record-count":3,"page-count":1},"links":{"first":"https://api.teamtailor.com/v1/departments?page%5Bnumber%5D=1&page%5Bsize%5D=10","last":"https://api.teamtailor.com/v1/departments?page%5Bnumber%5D=1&page%5Bsize%5D=10"}}

{"data":{"id":"337","type":"departments","links":{"self":"https://api.teamtailor.com/v1/departments/337"},"attributes":{"name":"Product Developments","people-headline":"hello people","people-text":"<p>this is us</p>","row-order":-4194303,"headline":"Building the future.","text":"We know how to build great products. We have built products used by over 5000 companies in the nordics. We are a small team of senior and junior product builders. We live and breath Ruby on rails. We are always looking for smart & fun people so don't be a stranger. Contact us today.","pictures":[{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,f_auto,g_faces:center,h_465,q_80,w_930/v1422365162/f3kp2yz3wickhtqrb50s.jpg"}]},"relationships":{"roles":{"links":{"self":"https://api.teamtailor.com/v1/departments/337/relationships/roles","related":"https://api.teamtailor.com/v1/departments/337/roles"}}}}}

{"data":{"id":"1337","type":"job-applications","links":{"self":"https://api.teamtailor.com/v1/job-applications/1337"},"attributes":{"created-at":"2017-02-20T10:30:43.910+01:00","cover-letter":"To Whom It May Concern…","updated-at":"2017-02-20T13:36:12.406+01:00","rejected-at":null,"referring-url":null,"referring-site":null,"sourced":true,"changed-stage-at":"2017-01-11T11:29:48.841+01:00"},"relationships":{"candidate":{"links":{"self":"https://api.teamtailor.com/v1/job-applications/1337/relationships/candidate","related":"https://api.teamtailor.com/v1/job-applications/1337/candidate"}},"job":{"links":{"self":"https://api.teamtailor.com/v1/job-applications/1337/relationships/job","related":"https://api.teamtailor.com/v1/job-applications/1337/job"}},"stage":{"links":{"self":"https://api.teamtailor.com/v1/job-applications/1337/relationships/stage","related":"https://api.teamtailor.com/v1/job-applications/1337/stage"}}}}}

{"data":[{"id":"44221","type":"questions","links":{"self":"https://api.teamtailor.com/v1/questions/44221"},"attributes":{"alternatives":null,"end-with":null,"multiple":null,"question-type":"Boolean","start-with":null,"title":"Have you ever worked with sales before?","unit":null,"single-line":null},"relationships":{"candidate":{"links":{"self":"https://api.teamtailor.com/v1/questions/44221/relationships/candidate","related":"https://api.teamtailor.com/v1/questions/44221/candidate"}}}},…],"meta":{"record-count":20,"page-count":1},"links":{"first":"https://api.teamtailor.com/v1/questions?page%5Bnumber%5D=1&page%5Bsize%5D=10","next":"https://api.teamtailor.com/v1/questions?page%5Bnumber%5D=2&page%5Bsize%5D=10","last":"https://api.teamtailor.com/v1/questions?page%5Bnumber%5D=2&page%5Bsize%5D=10"}}

Use this endpoint to retrieve lists of questions.

Example parameters

Parameter

Default

Description

include

null

Comma separated list of relations to include in the response. For example candidate.

{"data":[{"id":"819","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/819"},"attributes":{"description":"<p>\r\n\t I have been doing IT-related business/product development for the last 10 years. Working with great companies such as Skype, Mynewsdesk and now Teamtailor.</p><p>\r\n\t<span style=\"line-height: 1.45em; background-color: initial;\">At Teamtailor we do not have any formal HR-experience, we just love the web. Through our own recruitment activities the last couple of years we have come to realize that there is much that can be done and improved.</span><span style=\"line-height: 1.45em; background-color: initial;\">.. We just had to do something.</span></p>","email":"erik@example.com","facebook-profile":"https://www.facebook.com/eandersson","google-profile":"","hide-email":false,"instagram-profile":"http://instagram.com/erianderssson","linkedin-profile":"http://se.linkedin.com/in/erikandersson","name":"Erik Andersson","other-profile":"","phone":"+46735000131","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1418376224/bhtsaivvnjj1zk4kpgjn.jpg"},"role":"admin","title":"CEO","twitter-profile":"","username":"erikandersson2","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/819/relationships/department","related":"https://api.teamtailor.com/v1/users/819/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/819/relationships/location","related":"https://api.teamtailor.com/v1/users/819/location"}}}},{"id":"1801","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/1801"},"attributes":{"description":"<p>\r\n\t Coming from no computer science background, I'm a passionate web developer with lots of love for the frameworks and tools I use.</p><p>\r\n\t I love building modern applications for businesses, using the web to solve problems – and improving the way people work. And I have done so in the last 10 years, previously building Mynewsdesk from a small startup, to the international company today.</p><p>\r\n\t My daily work include Ruby on Rails, Ember.js, Sass, redis, PostgreSQL, Elasticsearch, and managing our cloud hosting. All the stuff you need to build modern web applications!</p>","email":"richard@example.com","facebook-profile":"https://www.facebook.com/richard.johansson","google-profile":"","hide-email":false,"instagram-profile":"http://instagram.com/richardjohansso","linkedin-profile":"http://se.linkedin.com/in/richardjohansson","name":"Richard Erik Johansson","other-profile":"","phone":"","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1472197022/ctiiyiwfpif7nhdjuf6l.jpg"},"role":"user","title":"Developer","twitter-profile":"http://Twitter.com/richardjohansso","username":"richarderikjohansson","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/1801/relationships/department","related":"https://api.teamtailor.com/v1/users/1801/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/1801/relationships/location","related":"https://api.teamtailor.com/v1/users/1801/location"}}}},{"id":"2199","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/2199"},"attributes":{"description":"<p>\r\n\t I love working at Teamtailor because I think we're trying to solve a <strong>real</strong> and <strong>important</strong> problem. The way HR and recruiting works needs to change. We help companies to become better at market themselves as an attractive workplace, and to engage their current employees in the recruiting process.</p><p>\r\n\t I've been building products/services on the web since 1999. A lot of strange stuff <span style=\"line-height: 1.45em; background-color: initial;\">and the occasional success.</span></p><p>\r\n\t <span style=\"line-height: 1.45em; background-color: initial;\"></span></p><p>\r\n\t <span style=\"line-height: 1.45em; background-color: initial;\"></span></p><p>\r\n\t <span style=\"line-height: 1.45em; background-color: initial;\"> </span></p><p>\r\n\t <span style=\"line-height: 1.45em; background-color: initial;\"></span></p>","email":"david@example.com","facebook-profile":"http://www.facebook.com/david.wennergren","google-profile":"","hide-email":false,"instagram-profile":"","linkedin-profile":"http://se.linkedin.com/in/davidwennergren/","name":"David Richard Wennergren","other-profile":"","phone":"070-7164007","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1418376331/e5xiuhwkkyy1lkpoc5vv.jpg"},"role":"recruiter","title":"Developer","twitter-profile":"http://twitter.com/davidwennergren","username":"david","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/2199/relationships/department","related":"https://api.teamtailor.com/v1/users/2199/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/2199/relationships/location","related":"https://api.teamtailor.com/v1/users/2199/location"}}}},{"id":"3362","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/3362"},"attributes":{"description":"<p>\r\n\t<img src=\"http://res.cloudinary.com/teamtailor/image/upload/t_span8/iveduppqqyywm12wmn3z.jpg\"></p>","email":"kim@example.com","facebook-profile":"https://www.facebook.com/kimchipchop","google-profile":"","hide-email":false,"instagram-profile":"http://instagram.com/kimchipchop","linkedin-profile":"http://se.linkedin.com/pub/kim-alm/4b/4a7/2b1/","name":"Kim Alm","other-profile":"","phone":"0709-851211","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1418376420/boneodn9lviq2h94suqo.jpg"},"role":"user","title":"Sales","twitter-profile":"https://twitter.com/kimchipchop","username":"kimalm1","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/3362/relationships/department","related":"https://api.teamtailor.com/v1/users/3362/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/3362/relationships/location","related":"https://api.teamtailor.com/v1/users/3362/location"}}}},{"id":"3595","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/3595"},"attributes":{"description":"<p>\r\n\t <span style=\"line-height: 1.45em; background-color: initial;\">I’m an artisan and a digital creative, in other words &mdash; I’m a web designer. I push pixels for a clear and beautiful web, making your screen look so delicious you may want to lick it. However, good web design is not just about the pretty things. Web sites have users that interacts with them &mdash; that’s why I like to realise my design solutions as well, making sure it works just the way it is meant to.</span></p>","email":"joakim@example.com","facebook-profile":"","google-profile":"","hide-email":false,"instagram-profile":"http://instagram.com/joakimnordlund","linkedin-profile":"http://www.linkedin.com/pub/joakim-nordlund/31/ba4/b32","name":"Joakim Nordlund","other-profile":"http://joakimnordlund.com","phone":"0701099987","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1430314931/lou1lraaahi9g6cueajf.jpg"},"role":"admin","title":"Web Designer","twitter-profile":"https://twitter.com/northgrove","username":"joakimnordlund","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/3595/relationships/department","related":"https://api.teamtailor.com/v1/users/3595/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/3595/relationships/location","related":"https://api.teamtailor.com/v1/users/3595/location"}}}},{"id":"4468","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/4468"},"attributes":{"description":"<p>test</p>","email":"jonas@example.com","facebook-profile":"https://www.facebook.com/himynameisjonas","google-profile":"","hide-email":false,"instagram-profile":"http://instagram.com/himynameisjonas","linkedin-profile":"https://www.linkedin.com/in/himynameisjonas","name":"Jonas Brusman","other-profile":"http://himynameisjonas.net","phone":"","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1423832344/hbwennnqa7uo7kubkzry.jpg"},"role":"admin","title":"Developer","twitter-profile":"https://twitter.com/himynameisjonas","username":"jonas5","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/4468/relationships/department","related":"https://api.teamtailor.com/v1/users/4468/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/4468/relationships/location","related":"https://api.teamtailor.com/v1/users/4468/location"}}}},{"id":"4660","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/4660"},"attributes":{"description":"","email":"calle@example.com","facebook-profile":"","google-profile":"","hide-email":false,"instagram-profile":"","linkedin-profile":"http://se.linkedin.com/in/callehenningsson","name":"Calle Henningsson","other-profile":"","phone":"070-8765959","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1442566435/wjnnrxolc1zd0pqrksbv.jpg"},"role":"no_access","title":"Sales","twitter-profile":"","username":"callehenningsson1","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/4660/relationships/department","related":"https://api.teamtailor.com/v1/users/4660/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/4660/relationships/location","related":"https://api.teamtailor.com/v1/users/4660/location"}}}},{"id":"5334","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/5334"},"attributes":{"description":"","email":"suzan@example.com","facebook-profile":"","google-profile":"","hide-email":false,"instagram-profile":"","linkedin-profile":"http://se.linkedin.com/in/suzandil","name":"Suzan Dil","other-profile":"","phone":"+46 70-547 06 44","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1438766374/mynvx9ypejez1xafegn6.jpg"},"role":"no_access","title":"Marketing","twitter-profile":"","username":"suzandil","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/5334/relationships/department","related":"https://api.teamtailor.com/v1/users/5334/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/5334/relationships/location","related":"https://api.teamtailor.com/v1/users/5334/location"}}}},{"id":"9067","type":"users","links":{"self":"https://api.teamtailor.com/v1/users/9067"},"attributes":{"description":"","email":"christoffer@example.com","facebook-profile":"","google-profile":"","hide-email":false,"instagram-profile":"","linkedin-profile":"","name":"Christoffer Ankarstrand","other-profile":"","phone":"","picture":{"standard":"https://res.cloudinary.com/teamtailor-development/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v1438700213/tbmdlece0wleejpuw410.jpg"},"role":"admin","title":"Sales","twitter-profile":"","username":"christofferankarstrand2","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":true,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"https://api.teamtailor.com/v1/users/9067/relationships/department","related":"https://api.teamtailor.com/v1/users/9067/department"}},"location":{"links":{"self":"https://api.teamtailor.com/v1/users/9067/relationships/location","related":"https://api.teamtailor.com/v1/users/9067/location"}}}}],"meta":{"record-count":20,"page-count":2},"links":{"first":"https://api.teamtailor.com/v1/users?page%5Bnumber%5D=1&page%5Bsize%5D=10","next":"https://api.teamtailor.com/v1/users?page%5Bnumber%5D=2&page%5Bsize%5D=10","last":"https://api.teamtailor.com/v1/users?page%5Bnumber%5D=2&page%5Bsize%5D=10"}}

Use this endpoint to retrieve lists of users.

Example parameters

Parameter

Default

Description

include

null

Comma separated list of relations to include in the response. For example department,location.

{"data":{"id":"819","type":"users","links":{"self":"http://api.teamtailor.com/v1/users/819"},"attributes":{"description":"<p>Hi! This is my public profile.</p><p>I can introduce myself with HTML here.</p>","email":"erik@example.com","facebook-profile":"https://www.facebook.com/erikeriksson","google-profile":"","hide-email":false,"instagram-profile":"http://instagram.com/erikeriksson","linkedin-profile":"http://se.linkedin.com/in/erikeriksson","name":"Erik Eriksson","other-profile":"","phone":"+46731231231","picture":{"standard":"https://res.cloudinary.com/teamtailor-production/image/upload/c_fill,dpr_2.0,f_auto,g_faces:center,h_160,q_80,w_160/v150512323/bhtsaivvnjj1zasvv12sa.jpg"},"role":"admin","title":"My New Title","twitter-profile":"","username":"erikeriksson","visible":true,"notification-candidate-message":true,"notification-job":true,"notification-connected-candidate":true,"notification-mention":true,"notification-lead-message":true,"notification-hiring-team-application":true,"notification-daily-digest":false,"notification-recruiter-application":true,"notification-removal-request":true,"notification-gdpr-digest":true},"relationships":{"department":{"links":{"self":"http://api.teamtailor.com/v1/users/819/relationships/department","related":"http://api.teamtailor.com/v1/users/819/department"}},"location":{"links":{"self":"http://api.teamtailor.com/v1/users/819/relationships/location","related":"http://api.teamtailor.com/v1/users/819/location"}}}}}