API Endpoints
Each endpoint allows manipulating items of certain type (see below). In particular, it is possible to view items
with a GET
request, add new items with a POST
request, modify existing items with a
PATCH
request, and delete them with a DELETE
request.
/accounts
Endpoint Item
The endpoint works with theaccount
items. Click here to view item description.
/clients
Endpoint Item
The endpoint works with theclient
items. Click here to view item description.
/jobs
Endpoint Item
The endpoint works with thejob
items. Click here to view item description.
/jobs/search
Endpoint Item
The endpoint works with thejob
items. Click here to view item description.
/statuses
Endpoint Item
The endpoint works with thestatus
items. Click here to view item description.
/notes
Endpoint Item
The endpoint works with thenote
items. Click here to view item description.
/visits
Endpoint Item
The endpoint works with thevisit
items. Click here to view item description.
/v2/visits
Endpoint Item
The endpoint works with thevisit
items. Click here to view item description.
/customFields
Endpoint Item
The endpoint works with thecustomField
items. Click here to view item description.
/files
The /files
endpoint allows managing files (such as images or PDF documents) uploaded by an application or directly via the web interface.
Binary Data Upload
You can upload binary data by sending a POST
request to the /files/upload
action endpoint. Put binary data into the
request body and specify the MIME type of the file in the Content-Type
header. The name of the file can be specified in
the Content-Disposition
header (otherwise it will be generated by the API Server).
A sample upload request may look as follows:
POST /files/upload HTTP/1.1
Host: api.geoop.com
Authorization: Bearer oJ_7Hj.f-F3f.kL
X-Version: 1.0
Content-Type: application/pdf
Content-Disposition: filename="My PDF Document"
Length: 125591
Binary_data
Binary Data Download
Check the url
property of file
item to get the download URL for that file.
Please note that to download the file a client needs to provide a valid API access token in the Authorization
header.
Endpoint Item
The endpoint works with thefile
items. Click here to view item description.
/users
The /users
endpoint allows managing user accounts.
Endpoint Item
The endpoint works with theuser
items. Click here to view item description.
/workgroups
Endpoint Item
The endpoint works with theworkgroup
items. Click here to view item description.