Public REST API : 1.0

Methods

An overview of the methods available in this version of the API

[
    {
        "id": "24050",
        "name": "Acme Corp"
    }
]

{
    "id": "24050",
    "name": "Acme Corp"
}

[
    {
        "id": "120590",
        "name": "Acme Corp - London Office",
        "has_integrations": true
    }
]

{
    "id": "120590",
    "name": "Acme Corp - London Office",
    "has_integrations": true
}

[
    {
        "val": "52.24",
        "date": "2019-02-05"
    }
]

[
    {
        "val": "52.24",
        "date": "2019-02-05"
    }
]

Models

An overview of the models available in this version of the API

Error Codes

An overview of the custom error codes that will be sent as part of the meta object on 400 badrequest calls when validation errors occur

ERR:MSG:RATELIMITTED

Provided when a ratelimit (read/write) is hit

ERR:MSG:VALIDATION:MALFORMED

General catch-all for malformed parameters

ERR:MSG:VALIDATION:GROUP_BY_MALFORMED

Group by parameter is malformed

ERR:MSG:VALIDATION:GROUP_BY_UNKNOWN

Unknown group by parameter was passed

ERR:MSG:VALIDATION:START_MALFORMED

Start date parameter is malformed

ERR:MSG:VALIDATION:START_FORMAT

Start date parameter was not in the correct format (YYYY-MM-DD)

ERR:MSG:VALIDATION:END_MALFORMED

End date parameter is malformed

ERR:MSG:VALIDATION:END_FORMAT

End date parameter was not in the correct format (YYYY-MM-DD)

ERR:MSG:VALIDATION:END_BEFORE_START

End date parameter was passed as being before start date

ERR:MSG:VALIDATION:END_EQUALS_START

End date parameter was passed as being equal to start date

ERR:MSG:VALIDATION:END_TODAY_OR_FUTURE

End date parameter was passed as being today or in the future

ERR:MSG:VALIDATION:START_TOO_OLD

Start date parameter is too old (can not be older than 1 year)