person-controller

List companions

List companions from the repository.

get/api/persons/{personId}/companions

Request

Base URL
https://api.myverifly.com
Auth
none declared
TypeScript
https://skmtc.dev/myverifly/apis/api-documentation/docs/api/persons/:personId/companions/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

personIdstring required

personId

Query parameters

listTempboolean

listTemp

Response

firstNamestring

First name

hrefstring

href

idstring

lastNamestring

lastName

personIdstring

personId

Example response

[
  {
    "firstName": "John",
    "href": "http://localhost:9001/api/persons/56JBQEDRINAM4VJ2VTWPEC7XCM/companion/56JBQEDRINAM4VJ2VTWPEC7XCN",
    "id": "56JBQEDRINAM4VJ2VTWPEC7XCM",
    "lastName": "Doe",
    "personId": "56JBQEDRINAM4VJ2VTWPEC7XCM"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.