IntelyCare Logo
API docs by Redocly

IntelyCare API Documentation (1.0.0)

Download OpenAPI specification:Download

API Support: apisupport@intelycare.com License: Apache 2.0

Introduction

Welcome to the IntelyCare API documentation, your gateway to seamless integration with the IntelyCare Staffing platform. Our REST API empowers clients to efficiently create shift requests, enabling a streamlined process for managing workforce scheduling. By leveraging this API, you can enhance your systems with real-time information about shift status, including when a shift has been filled and details about the assigned IntelyPro.

Overview

The IntelyCare API facilitates communication between your application and the IntelyCare platform, enabling a seamless exchange of data. This documentation serves as a comprehensive guide to help you integrate your systems with our powerful RESTful API. All requests and responses are JSON-encoded, and use standard HTTP response codes and authentication schemes. Bulk operations are not supported. You can work with only one object per request.

To get started with the IntelyCare API, refer to the detailed documentation below. We provide comprehensive information on authentication, endpoints, request and response formats, and error handling.

Authentication

IntelyCare offers the following authentication schemes:

Type Usage Description Example
apiKey REST APIs Required as X-API-KEY header for all RESTful calls d1015a83-9f5f-4a4d-b5fd-4e756ed1d282
HMAC Signature (SHA256) Webhooks Provided as X-Signature-IC header on all webhooks bcc151a55acf3d93c097e768f2b96f82d91b56d6fe2a102818b70f0fdfd0ccd1

:memo: Note: API Keys are tied to individual clients and cannot be used outside their provided scope

Support and Assistance

If you have any questions, encounter issues, or require assistance during the integration process, our dedicated support team is here to help. Reach out to apisupport@intelycare.com for prompt and reliable assistance.

Thank you for choosing IntelyCare. Let's build a more efficient and connected healthcare workforce together!

Shift

Integrate with the IntelyCare platform to create shift requests effortlessly. Our API allows you to programmatically submit and manage shift requests, providing you with the flexibility to adapt to your workforce scheduling needs.

Create

Authorizations:
ApiKeyAuth
header Parameters
X-API-KEY
required
string
Example: d1015a839f5f

API key issued to a specific client. This can only be used to access data within the client scope.

X-CLIENT-ID
required
string
Example: 1234

Intelycare's Unique identifier of the client.

Request Body schema: application/json
externalShiftId
required
string

Unique identifier for the shift

shiftStartTime
required
string

Shift start date/time can be in the UTC timezone in ISO 8601 format ex. "2024-01-24T05:04:34Z" OR Local Time by omitting the "Z" at the end. ex. "2024-01-24T05:04:34". The local time will be based on the configuration of the facility in the IntelyCare system.

shiftEndTime
required
string

Shift end date/time can be in the UTC timezone in ISO 8601 format ex. "2024-01-24T05:04:34Z" OR Local Time by omitting the "Z" at the end. ex. "2024-01-24T05:04:34". The local time will be based on the configuration of the facility in the IntelyCare system.

shiftUnit
required
string

Facility unit where the care should be delivered by the healthcare professional

healthcareProfessionalType
required
string

Healthcare professional qualification needed for the given shift. For example: “CNA”,”LPN”,”RN”.

shiftSource
required
string

Shift origination point

timezone
string

Timezone for the shifts

shiftBoostPercentage
integer
Default: 0

Percentage amount for boosting the shift

Responses

Request samples

Content type
application/json
{
  • "externalShiftId": "2546810",
  • "shiftStartTime": "2024-01-16T23:00:00",
  • "shiftEndTime": "2024-01-17T07:00:00",
  • "shiftUnit": "1st Floor",
  • "healthcareProfessionalType": "LPN",
  • "shiftSource": "qwerty",
  • "shiftBoostPercentage": 10,
  • "timezone": "ET"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update

Authorizations:
ApiKeyAuth
path Parameters
shiftId
required
string
Example: 10174202

Intelycare's Unique identifier of the shift.

header Parameters
X-API-KEY
required
string
Example: d1015a83-9f5f-4a4d-b5fd-4e756ed1d282

API key issued to a specific client. This can only be used to access data within the client scope.

X-CLIENT-ID
required
string
Example: 1234

Intelycare's Unique identifier of the client.

Request Body schema: application/json
shiftStartTime
required
string

Shift start date/time can be in the UTC timezone in ISO 8601 format ex. "2024-01-24T05:04:34Z" OR Local Time by omitting the "Z" at the end. ex. "2024-01-24T05:04:34". The local time will be based on the configuration of the facility in the IntelyCare system.

shiftEndTime
required
string

Shift end date/time can be in the UTC timezone in ISO 8601 format ex. "2024-01-24T05:04:34Z" OR Local Time by omitting the "Z" at the end. ex. "2024-01-24T05:04:34". The local time will be based on the configuration of the facility in the IntelyCare system.

shiftUnit
required
string

Facility unit where the care should be delivered by the healthcare professional

healthcareProfessionalType
required
string

Healthcare professional qualification needed for the given shift. For example: “CNA”,”LPN”,”RN”.

shiftSource
required
string

Shift origination point

shiftBoostPercentage
integer
Default: 0

Percentage amount for boosting the shift

timezone
string

Timezone for the shifts

Responses

Request samples

Content type
application/json
{
  • "shiftStartTime": "2024-01-16T23:00:00",
  • "shiftEndTime": "2024-01-17T07:00:00",
  • "shiftUnit": "1st Floor",
  • "healthcareProfessionalType": "LPN",
  • "shiftSource": "qwerty",
  • "shiftBoostPercentage": 10,
  • "timezone": "ET"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete

Authorizations:
ApiKeyAuth
path Parameters
shiftId
required
string
Example: 10174202

Intelycare's Unique identifier of the shift.

header Parameters
X-API-KEY
required
string
Example: d1015a83-9f5f-4a4d-b5fd-4e756ed1d282

API key issued to a specific client. This can only be used to access data within the client scope.

X-CLIENT-ID
required
string
Example: 1234

Intelycare's Unique identifier of the client.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Timecard

Simplify billing reconciliation by exchanging timecard information seamlessly. Our API supports the exchange of accurate timekeeping data, ensuring a smooth and efficient process for both you and the IntelyCare platform.

Create

Authorizations:
ApiKeyAuth
header Parameters
X-API-KEY
required
string
Example: d1015a83-9f5f-4a4d-b5fd-4e756ed1d282

API key issued to a specific client. This can only be used to access data within the client scope.

X-CLIENT-ID
required
string
Example: 1234

Intelycare's Unique identifier of the client.

Request Body schema: application/json
externalShiftId
required
string

Unique identifier for the shift

checkIn
required
string

Shift check-in timestamp in ISO 8601 format and in UTC timezone

checkOut
required
string

Shift check-out timestamp in ISO 8601 format and in UTC timezone

breakDuration
required
integer

Duration (in minutes) of shift break

Responses

Request samples

Content type
application/json
{
  • "externalShiftId": "2546810",
  • "checkIn": "2024-01-17T07:00:00",
  • "checkOut": "2024-01-17T15:00:00",
  • "breakDuration": 30
}

Response samples

Content type
application/json
{
  • "clientId": 1234,
  • "externalShiftId": "2546810",
  • "checkIn": "2024-01-17T07:00:00",
  • "checkOut": "2024-01-17T15:00:00",
  • "breakDuration": 30,
  • "errors": null,
  • "createdAt": "2024-01-17T15:01:00"
}

Update

Authorizations:
ApiKeyAuth
header Parameters
X-API-KEY
required
string
Example: d1015a83-9f5f-4a4d-b5fd-4e756ed1d282

API key issued to a specific client. This can only be used to access data within the client scope.

X-CLIENT-ID
required
string
Example: 1234

Intelycare's Unique identifier of the client.

Request Body schema: application/json
externalShiftId
required
integer

Unique identifier for the shift

checkIn
required
string

Shift check-in timestamp in ISO 8601 format and in UTC timezone

checkOut
required
string

Shift check-out timestamp in ISO 8601 format and in UTC timezone

breakDuration
required
integer

Duration (in minutes) of shift break

Responses

Request samples

Content type
application/json
{
  • "externalShiftId": "2546810",
  • "checkIn": "2024-01-17T07:00:00",
  • "checkOut": "2024-01-17T15:00:00",
  • "breakDuration": 30
}

Response samples

Content type
application/json
{
  • "clientId": 1234,
  • "externalShiftId": "2546810",
  • "checkIn": "2024-01-17T07:00:00",
  • "checkOut": "2024-01-17T15:00:00",
  • "breakDuration": 30,
  • "errors": null,
  • "updatedAt": "2024-01-17T15:01:00"
}

Webhook Events

Real-time updates on the status of submitted shifts. The API response includes valuable information about the assigned IntelyPro, giving you insights into the workforce handling each shift.

Shift Accept Webhook

Webhook event for shift accept

Authorizations:
HMACSignature
header Parameters
X-Signature-IC
required
string
Example: a0b1c1d2e3f5a8b13c21d34e55f89a144b233c377d610e987f1597a2584b4181

The hash signature of the payload. IntelyCare webhooks uses a HMAC hex digest (SHA256) to compute the signature of the body payload with the webhook secret.

Request Body schema: application/json

Webhook event for shift accept

clientId
required
integer

Unique identifier of the client

externalShiftId
required
integer

Unique identifier for the shift

shiftStatus
required
string
Enum: "Accepted" "Completed" "Released" "Deleted"

Status of the shift

required
object

Healthcare Professional object containing all information about the assigned worker

statusTimestamp
required
string

Status timestamp in ISO 8601 format and in UTC timezone

Request samples

Content type
application/json
{
  • "clientId": 1234,
  • "externalShiftId": "2546810",
  • "shiftStatus": "Accepted",
  • "healthcareProfessional": {
    },
  • "statusTimestamp": "2024-01-17T15:01:00"
}

Shift Release Webhook

Webhook event for shift release

Authorizations:
HMACSignature
header Parameters
X-Signature-IC
required
string
Example: a0b1c1d2e3f5a8b13c21d34e55f89a144b233c377d610e987f1597a2584b4181

The hash signature of the payload. IntelyCare webhooks uses a HMAC hex digest (SHA256) to compute the signature of the body payload with the webhook secret.

Request Body schema: application/json

Webhook event for shift release

clientId
required
integer

Unique identifier of the client

externalShiftId
required
integer

Unique identifier for the shift

shiftStatus
required
string
Enum: "Accepted" "Completed" "Released" "Deleted"

Status of the shift

statusTimestamp
required
string

Status timestamp in ISO 8601 format and in UTC timezone

Request samples

Content type
application/json
{
  • "clientId": 1234,
  • "externalShiftId": "2546810",
  • "shiftStatus": "Released",
  • "statusTimestamp": "2024-01-17T15:01:00"
}