Retrieve Account Limits

GET 
https://secure.fleetio.com/api/v1/accounts/:id/limits

Retrieve the details of an Account's limits.

Request

Path Parameters

id stringrequired

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

200

OK

application/json

Schema

Schema

vehicles object
currentinteger
The number of Vehicles currently belonging to this Account.
Example: 485
maxintegernullable
The maximum number of Vehicles that may belong to this Account.
Example: 500
equipment object
currentinteger
The number of Equipment currently belonging to this Account.
Example: 39
maxintegernullable
The maximum number of Equipment that may belong to this Account.
Example: 100
groups object
currentinteger
The number of Groups currently belonging to this Account.
Example: 11
maxintegernullable
The maximum number of Groups that may belong to this Account.
Example: 25
custom_fields object
currentinteger
The number of Custom Fields currently belonging to this Account.
Example: 191
maxintegernullable
The maximum number of Custom Fields that may belong to this Account.
Example: 1000
roles object
currentinteger
The number of Roles currently belonging to this Account.
Example: 5
maxintegernullable
The maximum number of Roles that may belong to this Account.
Example: 50
document_storage object
currentinteger
The current size in bytes of documents belonging to this Account.
Example: 1134244315
maxintegernullable
The maximum number of bytes of document storage that may belong to this Account.
Example: 10000000000
contacts object
currentinteger
The number of Contacts currently belonging to this Account.
Example: 300
maxintegernullable
The maximum number of Contacts that may belong to this Account. null indicates no limit.
Example: 500

Example (auto)

{
  "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
  }
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/accounts/:id/limits' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

only — query

---vehiclesequipmentgroupscustom_fieldsrolesdocument_storagecontacts

ResponseClear

Click the Send API Request button above and see the response here!