Retrieve Account Limits

Retrieve the details of an Account's limits.

Path Parameters

id string required
Possible values: Value must match regular expression ^[0-9]+$
The id of the relevant record

Query Parameters

only string
Possible values: [vehicles, equipment, groups, custom_fields, roles, document_storage, contacts]
A comma-separated list of fields to include in the response. If this parameter is omitted, the response will include all fields. If this parameter is provided, the response will only include the field(s) specified.

Responses

application/json

Schema
Example (from schema)

Schema

vehicles object
current integer
The number of Vehicles currently belonging to this Account.
max integer
The maximum number of Vehicles that may belong to this Account.
equipment object
current integer
The number of Equipment currently belonging to this Account.
max integer
The maximum number of Equipment that may belong to this Account.
groups object
current integer
The number of Groups currently belonging to this Account.
max integer
The maximum number of Groups that may belong to this Account.
custom_fields object
current integer
The number of Custom Fields currently belonging to this Account.
max integer
The maximum number of Custom Fields that may belong to this Account.
roles object
current integer
The number of Roles currently belonging to this Account.
max integer
The maximum number of Roles that may belong to this Account.
document_storage object
current integer
The current size in bytes of documents belonging to this Account.
max integer
The maximum number of bytes of document storage that may belong to this Account.
contacts object
current integer
The number of Contacts currently belonging to this Account.
max integer
The maximum number of Contacts that may belong to this Account. null indicates no limit.

{
  "vehicles": {
    "current": 485,
    "max": 500
  },
  "equipment": {
    "current": 39,
    "max": 100
  },
  "groups": {
    "current": 11,
    "max": 25
  },
  "custom_fields": {
    "current": 191,
    "max": 1000
  },
  "roles": {
    "current": 5,
    "max": 50
  },
  "document_storage": {
    "current": 1134244315,
    "max": 10000000000
  },
  "contacts": {
    "current": 300,
    "max": 500
  }
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

The requested resource could not be located

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}