Get list of people

Get list of people

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
• 400

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• ContinuationToken string
• Items object[]

  Array [

  Guid guid required

  Revision int64 required

  PersonCreated guid

  PersonChanged guid

  TimestampCreated date-time

  TimestampChanged date-time

  FirstName string

  LastName string required

  NameSuffix string

  Code string

  Email string required

  PhoneNumber string

  Note string

  Inactive boolean required

  ClosedPeriodTo date

  ]

{
  "ContinuationToken": "string",
  "Items": [
    {
      "Guid": "string",
      "Revision": 0,
      "PersonCreated": "string",
      "PersonChanged": "string",
      "TimestampCreated": "2023-05-24T12:26:16.166Z",
      "TimestampChanged": "2023-05-24T12:26:16.166Z",
      "FirstName": "string",
      "LastName": "string",
      "NameSuffix": "string",
      "Code": "string",
      "Email": "string",
      "PhoneNumber": "string",
      "Note": "string",
      "Inactive": true,
      "ClosedPeriodTo": "2023-05-24"
    }
  ]
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• Error object

  Code string

  Message string

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

Loading...