API Reference

Create an assignment

post
https://api.runn.io/assignments/

Creates a new assignment and returns a list of assignments. If the specified time period of the assignment overlaps with scheduled leave, the assignment is split into multiple segments. Each segment is returned as a separate assignment in the response.

Body Params
number | null

The phase this assignment is for, if any

number
required

The person this assignment is for

number
required

The project this assignment is for

number
required

The role the person will be in for this assignment

date
required

The date this assignment starts. Format: YYYY-MM-DD

date
required

The date this assignment ends. When using isNonWorkingDay=true, this needs to be the same as the startDate. Format: YYYY-MM-DD

number
required
≥ 0
Defaults to 0

How many minutes per day are assigned

string

A note about this assignment

boolean
Defaults to true

Whether this assignment is billable. Must be false if the project is non-billable.

boolean

Determine whether this assignment is for a single weekend day or a single holiday. If left blank it will be set automatically

number | null

The workstream this assignment is for, if any

Headers
enum
required
Defaults to 1.0.0
Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago