9-c Zapier API Documentation

Direct use of Zapier API

We highly recommend using our zapier.com integration, you can however use api directly

Signing In (JWT Token)

To sign in use the following example

				
					curl 'https://external-ap-southeast-2.api.inductforwork.com/user/login' \
-X POST  \
--data-raw '{"username":"{{COMPANY_USER}}","password":"{{PASSWORD}}"}'

token returned is valid for 8h


Token structure is shown below

				
					{
    "ChallengeParameters": {},
    "AuthenticationResult": {
        "AccessToken": "eyJ...",
        "ExpiresIn": 28800,
        "TokenType": "Bearer",
        "RefreshToken": "eyJjd....",
        "IdToken": "eyJ...."
    }
}

In all subsequent requests, please use “AuthenticationResult”.”IdToken” value for “Authorization” header , The word “Bearer ” Must be present followed by the IdToken.

				
					-H 'Authorization: Bearer eyJ....'

Working with People/Contacts

List

NOTE: This will return newly created people/contacts for the last 2h, there is no new data created last 10 records will be returned

				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contacts/?offset=&limit='  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
    {
        "id": 173346,
        "InducteeID": 147947,
        "FirstName": "Amber",
        "LastName": "Morgan",
        "Email": "amber-morgan@inductforwork.com.au",
        "Mobile": "",
        "CompanyName": "Dickens, Jones and Jenkins",
        "Image": null,
        "CreateDate": "2022-07-07T02:24:36.315Z",
        "ZapierTempFieldID": null,
        "EmployeeType": ""
    }
]

Search

parameters:

  • FirstName
  • LastName
  • Email
				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contacts/search?FirstName=Amber'  \
-H 'Authorization: Bearer eyJ....' 

				
			
				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contacts/search?FirstName=Amber&LastName=Morgan&Email='  \
-H 'Authorization: Bearer eyJ....' 

				
			
				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contacts/search?FirstName=&LastName&Email=amber-morgan@inductforwork.com.au'  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
    {
        "id": 173346,
        "InducteeID": 147947,
        "FirstName": "Amber",
        "LastName": "Morgan",
        "Email": "amber-morgan@inductforwork.com.au",
        "Mobile": "",
        "CompanyName": "Dickens, Jones and Jenkins",
        "Image": null,
        "CreateDate": "2022-07-07T02:24:36.315Z",
        "ZapierTempFieldID": null,
        "EmployeeType": ""
    }
]

Create Contact

data:

				
					{ 
        "FirstName": "Json",
        "LastName": "Jones",
        "Email": "json-jones@inductforwork.com.au",
        "Mobile": "",
        "CompanyName": "Dickens, Jones and Jenkins",
        "ZapierTempFieldID": "123",
        "EmployeeType": ""
    }

ZapierTempFieldID can be used to store and later reference your internal ERP id for this user

EmployeeType: Apprentice, Cadet, Casual, Contractor, Full Time, Part Time, Shift Worker, Sub Contractor, Trainee, Volunteer, Other

				
					curl -X POST --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contact'  \
-H 'Authorization: Bearer eyJ....' \
--data-raw '{ "FirstName": "Json", "LastName": "Jones", "Email": "json-jones@inductforwork.com.au", "Mobile": "", "CompanyName": "Dickens, d Jenkins", "ZapierTempFieldID": 123, "EmployeeType": ""}'

output:

Working with Induction Courses

List

				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/inductions/'  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
  {
    "id": 320710,
    "Title": "General Safety Induction",
    "Description": "Reference: www.health.gov.au",
    "PassPercentage": 100,
    "SiteTitle": "Office Site"
  }
]

				
			
				
					{
  "id": 173587,
  "InducteeID": null,
  "FirstName": "Json",
  "LastName": "Jones",
  "Email": "json-jones@inductforwork.com.au",
  "Mobile": null,
  "CompanyName": "Dickens, d Jenkins",
  "Image": null,
  "CreateDate": "2022-07-09T06:01:45.808Z",
  "ZapierTempFieldID": "123",
  "EmployeeType": ""
}

Working with Induction Attempts

Create: Invite person/contact to induction

data:

				
					{
  "ToCompletedInDays": "3",
  "PersonID": "173587",
  "InductionCourseID": "320710"
}

				
			
				
					curl -X POST --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contact/induction-invite'  \
-H 'Authorization: Bearer eyJ....' \
--data-raw '{"ToCompletedInDays" : "3", "PersonID":"173587", "InductionCourseID":"123"}'

List

NOTE: This will return newly successful attempts for the last 2h, there is no new data created last 10 records will be returned

				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/attempts/?offset=&limit='  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
  {
    "id": 302854,
    "ReferenceID": "13bf636zc7da6b4869a1b911a6286df2",
    "InducteeID": 142090,
    "Status": "Successful",
    "InductionCompletedOn": "2022-05-22T07:25:36.123Z",
    "InductionExpiresOn": "9999-12-31T23:59:59.999Z",
    "InductionCourseID": 320710,
    "InductionTitle": "General Safety Induction",
    "CertificateURL": "https://s3.ap-southeast-2.amazonaws.com/user-generated-content-secure.inductforwork.com.au/6049c8ac4220746c9aca4708f62d3df3/302854-phoenix_phoenix-do-not-change.pdf?AWSAccessKeyId=ASIAWKRI4CWB73OFSU5O&Expires=1653282780&Signature=cCPSU1REeMucp3Abigpzo24dy7Y%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEGwaDmFwLXNvdXRoZWFzdC0yIkcwRQIhAJA9qUQRoXb2lAvkeV1kmkFo6DbKPbsHXs0PeoQZDA8mAiAIRxL6NVoAMSf4Rbl6TfnxrSKWG2PHM9w93qzrheKsGyqfAghVEAAaDDQzNDk1MTE2NTMxNSIMrDlyotcyrb%2BnO8lKKvwBD35f8mUHUsDaabJQQcxHAWrFGfmAGB4SU%2BzW0nM%2BNpBJcxCWGJO3PKfQLQfPGuiWdY0dUveMGcuLunxELQ2fRJRKF4ecQwtUIFyfPWRR7KuNcYrQlkiAzj0Dp4HkPzs8%2Be5fFI7DeJphHpYqzTZj04aBM8E2GlhKgPcYKfAEvN%2FzqF4VCYpA1%2BTFWXDi0zt11F37%2BjjJVntrTCXBPtgU0JOFmJHIb49AdebQOBxRWIMqsC2joVVUdhqRN7x3piLZmDk5CYg7kbiQQuNOrRGtDAb0uUBltOChAA6xtjhpt8vDy%2Bwb7d1ErmKf2Uv3Omi%2BQPMKxd%2FbXza6Y2e5MMSTrJQGOpoBN%2BQU4XbrHTvvmFLpJ3EePmNVi3OZSQE1qV4%2BREMGlaK30aebL9Gt3EuTztHMKxHVQ4cn9%2FzaMA290P40a4%2BxIuTEQC%2BRKMKqcbkWargjDHxMLGzcoj45vY34BQFgK0A2JEboZMhpNYjO7celslBCPZwoPFP22btpmXyRru1o1jCUWWiTxBuBdroye8YgSwQM3Qh3s9aFW5Tg6A%3D%3D",
    "InductionCopyURL": "https://s3.ap-southeast-2.amazonaws.com/user-generated-content-secure.inductforwork.com.au/6049c8ac4220746c9aca4708f62d3df3/302854-do-not-change-full.pdf?AWSAccessKeyId=ASIAWKRI4CWB73OFSU5O&Expires=1653282780&Signature=02ydeziDjp1u6qJUUc58EfnjUpA%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEGwaDmFwLXNvdXRoZWFzdC0yIkcwRQIhAJA9qUQRoXb2lAvkeV1kmkFo6DbKPbsHXs0PeoQZDA8mAiAIRxL6NVoAMSf4Rbl6TfnxrSKWG2PHM9w93qzrheKsGyqfAghVEAAaDDQzNDk1MTE2NTMxNSIMrDlyotcyrb%2BnO8lKKvwBD35f8mUHUsDaabJQQcxHAWrFGfmAGB4SU%2BzW0nM%2BNpBJcxCWGJO3PKfQLQfPGuiWdY0dUveMGcuLunxELQ2fRJRKF4ecQwtUIFyfPWRR7KuNcYrQlkiAzj0Dp4HkPzs8%2Be5fFI7DeJphHpYqzTZj04aBM8E2GlhKgPcYKfAEvN%2FzqF4VCYpA1%2BTFWXDi0zt11F37%2BjjJVntrTCXBPtgU0JOFmJHIb49AdebQOBxRWIMqsC2joVVUdhqRN7x3piLZmDk5CYg7kbiQQuNOrRGtDAb0uUBltOChAA6xtjhpt8vDy%2Bwb7d1ErmKf2Uv3Omi%2BQPMKxd%2FbXza6Y2e5MMSTrJQGOpoBN%2BQU4XbrHTvvmFLpJ3EePmNVi3OZSQE1qV4%2BREMGlaK30aebL9Gt3EuTztHMKxHVQ4cn9%2FzaMA290P40a4%2BxIuTEQC%2BRKMKqcbkWargjDHxMLGzcoj45vY34BQFgK0A2JEboZMhpNYjO7celslBCPZwoPFP22btpmXyRru1o1jCUWWiTxBuBdroye8YgSwQM3Qh3s9aFW5Tg6A%3D%3D",
    "SiteID": 550,
    "SiteTitle": "Office Site",
    "PersonID": 173587,
    "PersonFirstName": "Json",
    "PersonLastName": "Jones",
    "PersonImage": "https://s3.ap-southeast-2.amazonaws.com/user-generated-content.inductforwork.com.au/6049c2ac4220746c9aca4708f62d3df3/9409a1b53c12d75ae47f22acc310c1fa.jpg?AWSAccessKeyId=ASIAWKRI4CWB73OFSU5O&Expires=1653282780&Signature=1%2FuJ5i%2Bzx9NI7fYI4rUYtBEzmdA%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEGwaDmFwLXNvdXRoZWFzdC0yIkcwRQIhAJA9qUQRoXb2lAvkeV1kmkFo6DbKPbsHXs0PeoQZDA8mAiAIRxL6NVoAMSf4Rbl6TfnxrSKWG2PHM9w93qzrheKsGyqfAghVEAAaDDQzNDk1MTE2NTMxNSIMrDlyotcyrb%2BnO8lKKvwBD35f8mUHUsDaabJQQcxHAWrFGfmAGB4SU%2BzW0nM%2BNpBJcxCWGJO3PKfQLQfPGuiWdY0dUveMGcuLunxELQ2fRJRKF4ecQwtUIFyfPWRR7KuNcYrQlkiAzj0Dp4HkPzs8%2Be5fFI7DeJphHpYqzTZj04aBM8E2GlhKgPcYKfAEvN%2FzqF4VCYpA1%2BTFWXDi0zt11F37%2BjjJVntrTCXBPtgU0JOFmJHIb49AdebQOBxRWIMqsC2joVVUdhqRN7x3piLZmDk5CYg7kbiQQuNOrRGtDAb0uUBltOChAA6xtjhpt8vDy%2Bwb7d1ErmKf2Uv3Omi%2BQPMKxd%2FbXza6Y2e5MMSTrJQGOpoBN%2BQU4XbrHTvvmFLpJ3EePmNVi3OZSQE1qV4%2BREMGlaK30aebL9Gt3EuTztHMKxHVQ4cn9%2FzaMA290P40a4%2BxIuTEQC%2BRKMKqcbkWargjDHxMLGzcoj45vY34BQFgK0A2JEboZMhpNYjO7celslBCPZwoPFP22btpmXyRru1o1jCUWWiTxBuBdroye8YgSwQM3Qh3s9aFW5Tg6A%3D%3D",
    "PersonContactDetails": "json-sones@inductforwork.com.au",
    "ZapierTempFieldID": "123",
    "Document1_Name": "Sample Document",
    "Document1_Description": null,
    "Document1_DocumentText": "Sample Text",
    "Document1_FileURL": "https://s3.ap-southeast-2.amazonaws.com/user-generated-content-secure.inductforwork.com.au/6049c1ac4220746c9aca4708f62d3df3/4ca414e411d5b6c0519488216f452845.png?AWSAccessKeyId=ASIAWKRI4CWB73OFSU5O&Expires=1653282780&Signature=m35A6vNSdJWgsGyq0WeR0RwYKk0%3D&response-content-disposition=attachment%3Bfilename%3Dsample-driverlicence.png&x-amz-security-token=IQoJb3JpZ2luX2VjEGwaDmFwLXNvdXRoZWFzdC0yIkcwRQIhAJA9qUQRoXb2lAvkeV1kmkFo6DbKPbsHXs0PeoQZDA8mAiAIRxL6NVoAMSf4Rbl6TfnxrSKWG2PHM9w93qzrheKsGyqfAghVEAAaDDQzNDk1MTE2NTMxNSIMrDlyotcyrb%2BnO8lKKvwBD35f8mUHUsDaabJQQcxHAWrFGfmAGB4SU%2BzW0nM%2BNpBJcxCWGJO3PKfQLQfPGuiWdY0dUveMGcuLunxELQ2fRJRKF4ecQwtUIFyfPWRR7KuNcYrQlkiAzj0Dp4HkPzs8%2Be5fFI7DeJphHpYqzTZj04aBM8E2GlhKgPcYKfAEvN%2FzqF4VCYpA1%2BTFWXDi0zt11F37%2BjjJVntrTCXBPtgU0JOFmJHIb49AdebQOBxRWIMqsC2joVVUdhqRN7x3piLZmDk5CYg7kbiQQuNOrRGtDAb0uUBltOChAA6xtjhpt8vDy%2Bwb7d1ErmKf2Uv3Omi%2BQPMKxd%2FbXza6Y2e5MMSTrJQGOpoBN%2BQU4XbrHTvvmFLpJ3EePmNVi3OZSQE1qV4%2BREMGlaK30aebL9Gt3EuTztHMKxHVQ4cn9%2FzaMA290P40a4%2BxIuTEQC%2BRKMKqcbkWargjDHxMLGzcoj45vY34BQFgK0A2JEboZMhpNYjO7celslBCPZwoPFP22btpmXyRru1o1jCUWWiTxBuBdroye8YgSwQM3Qh3s9aFW5Tg6A%3D%3D",
    "Document1_FileName": "sample-driverlicence.webp",
    "Document1_FileBackURL": "",
    "Document1_FileNameBack": "",
    "Document1_DocumentIssuedDate": null,
    "Document1_DocumentExpiryDate": "2023-05-21T14:00:00.000Z"
  }
]

Note: All links will have 1h download limit

Working with Sites/Locations

List

				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/sites/'  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
  {
    "ID": 550,
    "Title": "Office Site",
    "UnitNumber": null,
    "StreetNumber": "446",
    "StreetName": "collins st",
    "Suburb": "Melbourne",
    "State": "Victoria",
    "PostCode": "3000",
    "Country": "Australia",
    "SpecialInstructions": null,
    "CreateDate": "2021-08-21T01:53:40.325Z"
  }
]

Search

parameters:

  • Address
				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/sites/?Address=collins'  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
  {
    "ID": 550,
    "Title": "Office Site",
    "UnitNumber": null,
    "StreetNumber": "446",
    "StreetName": "collins st",
    "Suburb": "Melbourne",
    "State": "Victoria",
    "PostCode": "3000",
    "Country": "Australia",
    "SpecialInstructions": null,
    "CreateDate": "2021-08-21T01:53:40.325Z"
  }
]

Working with Sign/in-out

List all signed-in

				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contacts/sign-in/'  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
  {
    "id": 7499,
    "PersonID": 173587,
    "InducteeID": 142090,
    "PersonFirstName": "Json",
    "PersonLastName": "Jones",
    "PersonEmail": "json-jones@inductforwork.com.au",
    "PersonMobile": "+61411304553",
    "PersonCompany": "Dickens, d Jenkins",
    "PersonImage": null,
    "ZapierTempFieldID": "123",
    "EmployeeType": "",
    "SignedIn": "2022-05-22T07:34:57.000Z",
    "SignedInImage": null,
    "SignedOut": null,
    "SignedOutImage": null,
    "ForcedSignedOutByUserName": null,
    "SiteTitle": "Office Site",
    "SiteID": 550
  }
]

List all signed-out

				
					curl -X GET --compressed 'https://external-ap-southeast-2.api.inductforwork.com/zapier/contacts/sign-out/'  \
-H 'Authorization: Bearer eyJ....'

output:

				
					[
  {
    "id": 7499,
    "PersonID": 173587,
    "InducteeID": 142090,
    "PersonFirstName": "Json",
    "PersonLastName": "Jones",
    "PersonEmail": "json-jones@inductforwork.com.au",
    "PersonMobile": "+61411304553",
    "PersonCompany": "Dickens, d Jenkins",
    "PersonImage": null,
    "ZapierTempFieldID": "123",
    "EmployeeType": "",
    "SignedIn": "2022-05-22T07:34:57.000Z",
    "SignedInImage": null,
    "SignedOut": "2022-05-22T07:39:07.000Z",
    "SignedOutImage": null,
    "ForcedSignedOutByUserName": null,
    "SiteTitle": "Office Site",
    "SiteID": 550
  }
]