Get list of people

GET 
/api/v2/People

Get list of people

Request

Query Parameters

ContinuationToken string

Token is needed, unless all records have been returned in previous request. Do not forget to pass also all other parameters.

Responses

200

Success

application/json

Schema

Schema

ContinuationToken stringnullable
Items object[]nullable
Array [
Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
TimestampChanged date-timenullable
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)

{
  "ContinuationToken": "string",
  "Items": [
    {
      "Guid": "string",
      "Revision": 0,
      "PersonCreated": "string",
      "PersonChanged": "string",
      "TimestampCreated": "2024-03-29T06:55:00Z",
      "TimestampChanged": "2024-03-29T06:55:00Z",
      "FirstName": "string",
      "LastName": "string",
      "NameSuffix": "string",
      "Code": "string",
      "Email": "string",
      "PhoneNumber": "string",
      "Note": "string",
      "Inactive": true,
      "ClosedPeriodTo": "2024-03-29",
      "ExternalKey": "string",
      "Branch": "string"
    }
  ]
}

400

Error

application/json

Schema

Schema

Error objectrequired
Code stringnullable
Message stringnullable

Example (from schema)

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

Loading...