Boardings

List of valid attributes:

Attribute	Description	Specifics
boarding_template_id	ID of template to use for user	Can only be set on create endpoint, Can be blank
boarding_type	’onboarding’ or ‘offboarding’	Must be set on creation, cannot be changed later
current_stage_id	ID of the current stage of the on- or offboarding	Cannot be set (as of now)
day	First or last workday of the employee who is being on- or offboarded	ISO-8601 date, is optional
discarded_at	Null or timestamp of removal	Null or timestamp, cannot be set
message	The welcome message that the employee sees in their profile, Only used for onboardings	Can only be set on update endpoint, is optional
status	Status of the on- or offboarding	Can only be set on update endpoint, allowed values are: running completed cancelled
user_id	ID of the user to start an on- or offboarding for	Can only be set on create endpoint, Must be set

The following relationships can be included in requests:

Relationship	Type
user	has one

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete an on- or offboarding

Meta data: Progress

Allowed values	Description
true/false	Returns progress of the on- or offboarding as object with 2 keys: done number of tasks done in current stage, total number of tasks in current stage

Create

Example request:

{
  "data": {
    "type": "boarding",
    "data": {
      "attributes": {
        "boarding_template_id": "bfe62b17-8640-43b4-8c8c-7324aad4b8a9",
        "user_id": "0047042d-8640-49a2-8047-a51d8b99588c"
      }
    }
  }
}

Example response:

{
  "data": {
    "id": "52370ab1-7d08-4a03-b0ac-4ba63c8f209d",
    "type": "boarding",
    "attributes": {
      ...
    }
  }
}

On success, this endpoint starts an on- or offboading for a user based on a template. If no template is chosen it starts an empty process.

HTTP Request

POST /api/v1/boardings

Update

Example request:

{
  "data": {
    "type": "boarding",
    "attributes": {
      "status": "cancelled"
    }
  }
}

Example response:

{
  "data": {
    "id": "2ce7ed10-90d4-45da-b284-67966f488e2d",
    "type": "boarding",
    "attributes": {
      ...
    }
  }
}

This endpoint updates an on- or offboarding.

HTTP Request

PUT /api/v1/boardings/:boarding_id

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding to update

Show

Example response:

{
  "data": {
    "id": "eb02f468-7a20-42fd-9981-95c70e0ee57d",
    "type": "boarding",
    "attributes": {
      ...
    }
  }
}

This endpoint returns an on- or offboarding.

HTTP Request

GET /api/v1/boardings/:boarding_id

URL Parameters

Parameter	Description
boarding_id	ID of the on- or offboarding to return

List

This endpoint returns JSON structured like this:

{
  "data": [
    {
      "id": "e4bdb620-00c1-4d7d-9d26-f08c2e9dee09",
      "data": {
        "type": "boarding",
        "attributes": {
          ...
        }
      },
      "meta": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns boardings.

HTTP Request

GET /api/v1/boardings

Delete

Example response:

{
  "data": {
    "id": "2ce7ed10-90d4-45da-b284-67966f488e2d",
    "type": "boarding",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes an on- or offboarding.

HTTP Request

DELETE /api/v1/boardings/:boarding_id

URL Parameters

Parameter	Description
boarding_id	The ID of the on- or offboarding to delete