Get person

GET 
/api/v2/People/:key

Get person

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guidguid
Revisionint64
PersonCreatedguidnullable
PersonChangedguidnullable
TimestampCreateddate-timenullable
Example: 2025-02-24T10:14:00Z
TimestampChangeddate-timenullable
Example: 2025-02-24T10:14:00Z
FirstNamestringnullable
LastNamestringnullablerequired
NameSuffixstringnullable
Codestringnullable
Emailstringnullablerequired
PhoneNumberstringnullable
Notestringnullable
Inactiveboolean
ClosedPeriodTodatenullable
ExternalKeystringnullable
Branchguidnullable
AccessLevelAccessLevel (string)

Possible values: [Denied, Allowed, Terminal]

SystemAdminboolean
TimeTrackingAdminboolean
VehiclesAdminboolean
ExpensesAdminboolean
ContractsAndInvoicingAdminboolean
ServicesBillingAdminnullable
BudgetsAdminboolean

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2025-02-24T10:14:00Z",
  "TimestampChanged": "2025-02-24T10:14:00Z",
  "FirstName": "string",
  "LastName": "string",
  "NameSuffix": "string",
  "Code": "string",
  "Email": "string",
  "PhoneNumber": "string",
  "Note": "string",
  "Inactive": true,
  "ClosedPeriodTo": "2024-07-29",
  "ExternalKey": "string",
  "Branch": "string",
  "AccessLevel": "Denied",
  "SystemAdmin": true,
  "TimeTrackingAdmin": true,
  "VehiclesAdmin": true,
  "ExpensesAdmin": true,
  "ContractsAndInvoicingAdmin": true,
  "BudgetsAdmin": true
}

400

Error

application/json

Schema

Schema

Error

object

required

Codestringnullable

Messagestringnullable

Example (from schema)

{
  "Error": {
    "Code": "string",
    "Message": "string"
  }
}

404

Not Found