API Documentation

API Endpoint

People

People

Supported filter params

  • id

  • status (1: active, 2: deactivated)

  • person_type (1: user, 2: contact, 3: placeholder)

  • role_id (array)

  • company_id (array)

  • tags

  • query

  • subscribable_type (task, deal, person, company, invoice, page)

  • subscribable_id (array)

Filter operations are supported on this endpoint.

GET /api/v2/people
Requestsreturns people

GET  /api/v2/people

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1033",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1019@email.com",
        "title": null,
        "joined_at": "2020-08-11T01:05:08.000+02:00",
        "last_seen_at": "2020-08-11T01:05:08.477+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:08.451+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 442
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1443"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1443",
      "type": "companies",
      "attributes": {
        "name": "Organization442",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:05:08.449+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 442
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/people?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/people?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Get people
GET/api/v2/people

GET /api/v2/people/1
Requestsreturns person

GET  /api/v2/people/1035

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1035",
    "type": "people",
    "attributes": {
      "first_name": "name",
      "last_name": "surname",
      "email": "person576@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": null,
      "invited_at": null,
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:08.549+02:00",
      "placeholder": false,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 443
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "44"
        }
      }
    }
  },
  "included": [
    {
      "id": "44",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary44",
        "invoice_number_format": null,
        "deleted_at": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 443
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Gets a person
GET/api/v2/people/{id}

URI Parameters
HideShow
id
number (required) Example: 1

person id

POST /api/v2/people
Requestscreates personreturns error

POST  /api/v2/people

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": "test name"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1037",
    "type": "people",
    "attributes": {
      "first_name": "test name",
      "last_name": null,
      "email": null,
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": null,
      "invited_at": null,
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:08.645+02:00",
      "placeholder": false,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 444
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

POST  /api/v2/people

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/first_name"
      }
    }
  ]
}

Create a person
POST/api/v2/people

URI Parameters
HideShow
first_name: `John` (string, required) - first_name
string (required) 
PATCH /api/v2/people/1
Requestsupdates personreturns error

PATCH  /api/v2/people/1040

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": "new name",
      "tag_list": [
        "junior",
        "remote"
      ]
    },
    "relationships": {
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "1041"
          },
          {
            "type": "people",
            "id": "1042"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1040",
    "type": "people",
    "attributes": {
      "first_name": "new name",
      "last_name": "surname",
      "email": "person577@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": null,
      "invited_at": null,
      "is_user": false,
      "tag_list": [
        "junior",
        "remote"
      ],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:08.776+02:00",
      "placeholder": false,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 446
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/people/1044

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/first_name"
      }
    }
  ]
}

Update a person
PATCH/api/v2/people/{id}

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/invite
Requestssets user and sends invitationreturns error

PATCH  /api/v2/people/1071/invite

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": "test name",
      "role_id": "3"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "1465"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "60"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1071",
    "type": "people",
    "attributes": {
      "first_name": "test first name",
      "last_name": "test last name",
      "email": "invite@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:10.000+02:00",
      "is_user": true,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:10.491+02:00",
      "placeholder": false,
      "color_id": null,
      "private_custom_reports_used": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 459
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1465"
        }
      },
      "subsidiary": {
        "data": {
          "type": "subsidiaries",
          "id": "60"
        }
      }
    }
  },
  "included": [
    {
      "id": "1465",
      "type": "companies",
      "attributes": {
        "name": "Organization459",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:05:10.464+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 459
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "60",
      "type": "subsidiaries",
      "attributes": {
        "name": "Subsidiary60",
        "invoice_number_format": null,
        "deleted_at": null,
        "archived_at": null,
        "export_integration_type_id": null,
        "invoice_logo_url": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 459
          }
        },
        "bill_from": {
          "data": null
        },
        "integration": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/people/1073/invite

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "people",
    "attributes": {}
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/role"
      }
    }
  ]
}

Invites a person
PATCH/api/v2/people/{id}/invite

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/resend
Requestsresend invitation mail

PATCH  /api/v2/people/1087/resend

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1087",
    "type": "people",
    "attributes": {
      "first_name": "test first name",
      "last_name": "test last name",
      "email": "user1063@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:11.000+02:00",
      "is_user": true,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:11.453+02:00",
      "placeholder": false,
      "color_id": null,
      "private_custom_reports_used": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 467
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1477"
        }
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1477",
      "type": "companies",
      "attributes": {
        "name": "Client1011",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:11.447+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 467
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Resend email to a person
PATCH/api/v2/people/{id}/resend

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/deactivate
Requestsdeactivates person

PATCH  /api/v2/people/1091/deactivate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1091",
    "type": "people",
    "attributes": {
      "first_name": "test first name",
      "last_name": "test last name",
      "email": "user1067@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": "2020-08-11T01:05:11.000+02:00",
      "archived_at": null,
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:11.000+02:00",
      "is_user": true,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:11.803+02:00",
      "placeholder": false,
      "color_id": null,
      "private_custom_reports_used": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 469
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1481"
        }
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1481",
      "type": "companies",
      "attributes": {
        "name": "Client1013",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:11.796+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 469
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Deactivates a person
PATCH/api/v2/people/{id}/deactivate

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/activate
Requestsactivates useractivates user

PATCH  /api/v2/people/1099/activate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1099",
    "type": "people",
    "attributes": {
      "first_name": "test first name",
      "last_name": "test last name",
      "email": "user1074@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:12.000+02:00",
      "is_user": true,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:12.308+02:00",
      "placeholder": false,
      "color_id": null,
      "private_custom_reports_used": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 473
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1488"
        }
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1488",
      "type": "companies",
      "attributes": {
        "name": "Client1016",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:12.304+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 473
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/people/1103/activate

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1103",
    "type": "people",
    "attributes": {
      "first_name": "test first name",
      "last_name": "test last name",
      "email": "user1077@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:12.000+02:00",
      "is_user": true,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:12.513+02:00",
      "placeholder": false,
      "color_id": null,
      "private_custom_reports_used": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 475
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "1491"
        }
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1491",
      "type": "companies",
      "attributes": {
        "name": "Client1017",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:12.509+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 475
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Activates a person
PATCH/api/v2/people/{id}/activate

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/archive
Requestsarchives personarchives persondeletes bookings and engagements

PATCH  /api/v2/people/1107/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1107",
    "type": "people",
    "attributes": {
      "first_name": "name",
      "last_name": "surname",
      "email": "person609@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": "2020-08-11T01:05:12.000+02:00",
      "role_id": null,
      "invited_at": null,
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:12.718+02:00",
      "placeholder": false,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 477
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/people/1109/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1109",
    "type": "people",
    "attributes": {
      "first_name": "name",
      "last_name": "surname",
      "email": "person610@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": "2020-08-11T01:05:12.000+02:00",
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:12.000+02:00",
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:12.827+02:00",
      "placeholder": true,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 478
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/people/1111/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1111",
    "type": "people",
    "attributes": {
      "first_name": "name",
      "last_name": "surname",
      "email": "person611@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": "2020-08-11T01:05:13.000+02:00",
      "role_id": 3,
      "invited_at": "2020-08-11T01:05:12.000+02:00",
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:12.947+02:00",
      "placeholder": true,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 479
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Archives a person
PATCH/api/v2/people/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

person id

PATCH /api/v2/people/1/restore
Requestsrestores personreturns errorrestores person

PATCH  /api/v2/people/1118/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1118",
    "type": "people",
    "attributes": {
      "first_name": "name",
      "last_name": "surname",
      "email": "person615@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": null,
      "invited_at": null,
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:13.714+02:00",
      "placeholder": false,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 482
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/people/1120/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {
        "pointer": null
      }
    }
  ]
}

PATCH  /api/v2/people/1124/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1124",
    "type": "people",
    "attributes": {
      "first_name": "name",
      "last_name": "surname",
      "email": "person618@email.com",
      "title": null,
      "joined_at": null,
      "last_seen_at": null,
      "deactivated_at": null,
      "archived_at": null,
      "role_id": null,
      "invited_at": null,
      "is_user": false,
      "tag_list": [],
      "avatar_url": null,
      "virtual": false,
      "custom_fields": null,
      "autotracking": false,
      "created_at": "2020-08-11T01:05:14.009+02:00",
      "placeholder": false,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 485
        }
      },
      "company": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Restores a person
PATCH/api/v2/people/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

person id

Generated by aglio on 10 Aug 2020