Class Manager
GET /v1/companies/{company}/accounts

List all accounts for a specific company

Path parameters

  • company string Required

    Company id

Responses

  • 200 application/json

    List collection response

    Hide response attributes Show response attributes object
    • id string Required

      Account ID

    • user_id string Required

      User ID

    • company_id string | null Required

      Company ID

    • entity_id string | null Required

      Staff or Family ID that links this account to an entity

    • role string Required

      Account role

    • permission_set string | null Required

      Staff permission set

    • status string Required

      Account status

    • user_name string Required

      User full name

    • user_email string Required

      User email address
  • 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/companies/{company}/accounts 
curl \
 --request GET 'https://classmanager.test/v1/companies/co_xxxxxxxx/accounts'
Response examples (200) 
[
  {
    "id": "acc_xxxxxxxx",
    "user_id": "usr_xxxxxxxx",
    "company_id": "co_xxxxxxxx",
    "entity_id": "stf_xxxxxxxx",
    "role": "admin",
    "permission_set": "owner",
    "status": "active",
    "user_name": "John Doe",
    "user_email": "john@example.com"
  }
]
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}