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: 2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example: 2024-10-07T12:48:00Z
FirstName stringnullable
LastName stringnullablerequired
NameSuffix stringnullable
Code stringnullable
Email stringnullablerequired
PhoneNumber stringnullable
Note stringnullable
Inactive boolean
ClosedPeriodTo datenullable
ExternalKey stringnullable
Branch guidnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-10-07T12:48:00Z",
  "TimestampChanged": "2024-10-07T12: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"
}

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...