Get an account

GET /api/accounts/{id}

Get an account's details by its ID in the system. Only available to Garmat administrators and for other users' own account.

Path parameters

id string Required

the ID of the account to retrieve

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- booths number
  
  Number of booths in the system associated to the account
- facilities number
  
  Number of facilities in the system associated to the account
- id string
  
  ID of the account in the system
- name string
  
  Name of the account
- regions number
  
  Number of regions in the system associated to the account
- status string
  
  Whether the account is active or has been deactivated
- type string
  
  Account type
- users number
  
  Number of users in the system associated to the account
401 application/json

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
404 application/json

Not Found
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/accounts/{id}

curl \
 --request GET 'http://localhost:4000/api/accounts/{id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "name": "Test Account",
  "type": "customer",
  "users": 5,
  "booths": 2,
  "status": "active",
  "facilities": 2
}

Response examples (200)

{
  "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "name": "Test Account",
  "type": "customer",
  "users": 5,
  "booths": 2,
  "status": "active",
  "facilities": 2
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (404)

{
  "error": "Error Reason"
}

Response examples (404)

{
  "error": "Error Reason"
}