Class Manager
GET /v1/contacts/{id}

Get Contact

Path parameters

  • id string Required

    Contact id

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • familyId string Required

      Family ID

    • firstname string Required

      Firstname

    • lastname string | null Required

      Lastname

    • email string | null Required

      Email

    • relation string | null Required

      Values are parent, grandparent, guardian, sibling, or other.

    • phone string | null Required

      Phone number

    • isPrimary boolean Required

      Is primary

    • isEmergency boolean Required

      Is emergency

    • isBilling boolean Required

      Is billing

    • isAdditional boolean Required

      Is additional

    • deletedAt string(date-time) | null Required

      Deleted at date
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/contacts/{id} 
curl \
 --request GET 'https://localhost/v1/contacts/con_xxxxxxxx'
Response examples (200) 
{
  "id": "stn_123123123123",
  "companyId": "co_123123123123",
  "familyId": "fml_123123123123",
  "firstname": "John",
  "lastname": "Doe",
  "email": "john@doe",
  "relation": "parent",
  "phone": "(123) 456 7890",
  "isPrimary": false,
  "isEmergency": false,
  "isBilling": false,
  "isAdditional": true,
  "deletedAt": "2023-12-05 14:30:41"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}