Get Person

GET 
/api/v2/People/:key

Get Person

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2025-05-21T07:48:00Z
TimestampChanged date-timenullable
Example: 2025-05-21T07:48:00Z
FirstName stringnullable
LastName stringnullable
NameSuffix stringnullable
Code stringnullable
Email stringnullable
PhoneNumber stringnullable
Note stringnullable
Inactive boolean
ClosedPeriodTo datenullable
ExternalKey stringnullable
Branch guidnullable
AccessLevel AccessLevel (string)

Possible values: [Denied, Allowed, Terminal]

SystemAdmin boolean
TimeTrackingAdmin boolean
VehiclesAdmin boolean
ExpensesAdmin boolean
ContractsAndInvoicingAdmin boolean
ServicesBillingAdmin nullable
BudgetsAdmin boolean

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2025-05-21T07:48:00Z",
  "TimestampChanged": "2025-05-21T07:48: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

Code stringnullable

Message stringnullable

Example (from schema)

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

404

Not Found

Loading...