Retrieve a milestone by ID

curl --request GET \
  --url https://api.zivio.net/api/v3/milestones/{id} \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "id": "66",
  "client_suggested": "true",
  "title": "Title of Milestone",
  "details": "Details of Milestone",
  "rate": "1500.00",
  "ccy": "GBP",
  "due_on": "2023-11-07T05:31:56Z",
  "notes": "some notes relating to the milestone",
  "comments": "some comments relating to the milestone",
  "job_id": "2669",
  "job_summary": "summary of miestone",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "approved_at": "2023-11-07T05:31:56Z",
  "approved_by": {
    "id": "7158",
    "first_name": "Jack",
    "last_name": "Jones",
    "email": "[email protected]",
    "org_name": "Organisation Ltd",
    "org_id": "567",
    "business_unit": "Public Private Partnerships",
    "division": "Infastructure",
    "department": "Bridges",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "<string>"
  },
  "level_1_approved_at": "2023-11-07T05:31:56Z",
  "level_1_approved_by": {
    "id": "258",
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "org_name": "Smith Co Ltd",
    "org_id": "200",
    "business_unit": "Public Private Partnerships",
    "division": "Infastructure",
    "department": "Bridges",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "<string>"
  },
  "children": [
    "124"
  ],
  "parents": [
    "14"
  ],
  "custom_fields": {
    "key": "value"
  }
}

GET

milestones

{id}

Retrieve a milestone by ID

curl --request GET \
  --url https://api.zivio.net/api/v3/milestones/{id} \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "id": "66",
  "client_suggested": "true",
  "title": "Title of Milestone",
  "details": "Details of Milestone",
  "rate": "1500.00",
  "ccy": "GBP",
  "due_on": "2023-11-07T05:31:56Z",
  "notes": "some notes relating to the milestone",
  "comments": "some comments relating to the milestone",
  "job_id": "2669",
  "job_summary": "summary of miestone",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "approved_at": "2023-11-07T05:31:56Z",
  "approved_by": {
    "id": "7158",
    "first_name": "Jack",
    "last_name": "Jones",
    "email": "[email protected]",
    "org_name": "Organisation Ltd",
    "org_id": "567",
    "business_unit": "Public Private Partnerships",
    "division": "Infastructure",
    "department": "Bridges",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "<string>"
  },
  "level_1_approved_at": "2023-11-07T05:31:56Z",
  "level_1_approved_by": {
    "id": "258",
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "org_name": "Smith Co Ltd",
    "org_id": "200",
    "business_unit": "Public Private Partnerships",
    "division": "Infastructure",
    "department": "Bridges",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "<string>"
  },
  "children": [
    "124"
  ],
  "parents": [
    "14"
  ],
  "custom_fields": {
    "key": "value"
  }
}

Authorizations

X-API-Key

string

header

required

zivio-tenant-id

string

header

required

Path Parameters

integer

required

Response

integer

Example:

"66"

client_suggested

boolean

Example:

"true"

title

string

Example:

"Title of Milestone"

details

string

Example:

"Details of Milestone"

rate

string

Example:

"1500.00"

ccy

string

Example:

"GBP"

due_on

string<date-time>

notes

string

Example:

"some notes relating to the milestone"

comments

string

Example:

"some comments relating to the milestone"

job_id

integer

Example:

"2669"

job_summary

string

Example:

"summary of miestone"

created_at

string<date-time>

updated_at

string<date-time>

status

string

Example:

"open"

approved_at

string<date-time>

approved_by

object

Show child attributes

approved_by.id

integer

Example:

"7158"

approved_by.first_name

string

Example:

"Jack"

approved_by.last_name

string

Example:

"Jones"

approved_by.email

string

Example:

"[email protected]"

approved_by.org_name

string

Example:

"Organisation Ltd"

approved_by.org_id

integer

Example:

"567"

approved_by.business_unit

string

Example:

"Public Private Partnerships"

approved_by.division

string

Example:

"Infastructure"

approved_by.department

string

Example:

"Bridges"

approved_by.vetting_status

string

Example:

"PASSED"

approved_by.created_at

string<date-time>

approved_by.updated_at

string<date-time>

approved_by.custom_fields

object

Show child attributes

approved_by.custom_fields.key

string

Example:

"value"

approved_by.has_oversight

string<true>

level_1_approved_at

string<date-time>

level_1_approved_by

object

Show child attributes

level_1_approved_by.id

integer

Example:

"258"

level_1_approved_by.first_name

string

Example:

"John"

level_1_approved_by.last_name

string

Example:

"Smith"

level_1_approved_by.email

string

Example:

"[email protected]"

level_1_approved_by.org_name

string

Example:

"Smith Co Ltd"

level_1_approved_by.org_id

integer

Example:

"200"

level_1_approved_by.business_unit

string

Example:

"Public Private Partnerships"

level_1_approved_by.division

string

Example:

"Infastructure"

level_1_approved_by.department

string

Example:

"Bridges"

level_1_approved_by.vetting_status

string

Example:

"PASSED"

level_1_approved_by.created_at

string<date-time>

level_1_approved_by.updated_at

string<date-time>

level_1_approved_by.custom_fields

object

Show child attributes

level_1_approved_by.custom_fields.key

string

Example:

"value"

level_1_approved_by.has_oversight

string<true>

children

integer[]

parents

integer[]

custom_fields

object

Show child attributes

custom_fields.key

string

Example:

"value"

Create a Milestone Delete a milestone by ID

⌘I

Endpoints

Authorizations

Path Parameters

Response