Class Manager
GET /v1/families/{id}/user

Get family invited user data

Path parameters

  • id string Required

    Family ID

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • firstname string | null Required

      Firstname

    • lastname string | null Required

      Lastname

    • email string Required

      User email

    • phone string | null Required

      User phone

    • emailVerifiedAt string | null Required

      User email verified at
  • 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/families/{id}/user 
curl \
 --request GET 'https://classmanager.test/v1/families/fml_xxxxxxxx/user'
Response examples (200) 
{
  "id": "usr_123123123123",
  "firstname": "John",
  "lastname": "Doe",
  "email": "new Email(john@example.com)",
  "phone": "+1 (123) xxx-xxxx",
  "emailVerifiedAt": "2023-11-08 14:05:51"
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}