Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: eVerbary Clio API
version: 0.1.0
tags:
- name: Clio
paths:
/clio/action:
get:
summary: Clio Action
description: 'The target of the custom action in Clio''s menus.
Clio appends its own parameters - the action, who clicked, and the URL of
the object clicked on - and the request arrives unauthenticated, so it can
be faked. `custom_action_nonce` is how Clio lets us prove otherwise: sent
back on our next API call, Clio checks the clicking user matches our token.
A wrinkle the documentation leaves implicit: Clio says who clicked but not
which firm''s token to use, and any user in a firm can click, not only
whoever installed the app. So the first click by an unknown user goes
through the authorisation round trip - instant when they are already signed
in to Clio and the firm has approved us - and the mapping is remembered.'
operationId: clio_action_clio_action_get
parameters:
- name: subject_url
in: query
required: false
schema:
type: string
default: ''
title: Subject Url
- name: user_id
in: query
required: false
schema:
type: integer
default: 0
title: User Id
- name: custom_action_nonce
in: query
required: false
schema:
type: string
default: ''
title: Custom Action Nonce
- name: custom_action_id
in: query
required: false
schema:
type: integer
default: 0
title: Custom Action Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Clio
/clio/deauthorized:
post:
summary: Deauthorized
description: 'Clio telling us a firm revoked our access.
Without this, a firm that uninstalls leaves live tokens sitting in our
database and the app keeps believing it may act for them. Clio posts
`client_id`, `user_id` and `access_token` - the last being the literal
string "all" when the user revoked everything rather than one token.
The request carries no signature; `client_id` is the only thing to check,
and it is weak. That is acceptable only because the action is to stop
trusting a token: the worst a forged call achieves is making a firm
reauthorise. Nothing is deleted and nothing is read.'
operationId: deauthorized_clio_deauthorized_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
tags:
- Clio
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError