Skip to main content

API Endpoints and URLs

You access Deepser resources by sending an HTTP request to the API server. The server replies with a response that contains the requested data, a status indicator, or both. This section explains how to construct your API URLs and understand the routing structure.

Replace deepserhost in all examples below with your actual Deepser domain.

Base URL​

All requests use the following base URL:

http[s]://deepserhost/api/rest/

You request a particular resource by appending a specific path to this base URL.

Request Structure​

To retrieve data, send an HTTP GET request to the base URL followed by the entity path. For example, to retrieve the list of companies:

http[s]://deepserhost/api/rest/companies

In this URL:

  • http[s]://deepserhost/api/rest is the endpoint
  • /companies is the action URL (the resource path)

Understanding Routes​

Each entity typically has two routes:

Collection Route​

The collection route retrieves multiple records and uses the plural form of the entity name. For the Company entity:

http[s]://deepserhost/api/rest/companies

Call this route with an HTTP GET request. You can append filters and parameters to narrow the results. For example, to retrieve only the first company with a name starting with "ACME":

http[s]://deepserhost/api/rest/companies?filter[1][attribute]=name&filter[1][like]=ACME%&limit=1

The query string in this example contains the following parts:

  • filter -- an array where each element defines a filter condition
  • [attribute] -- the field to filter on
  • [like] -- the comparison operator (SQL LIKE in this case)
  • limit -- restricts the response to one record

For a complete list of available filters and parameters, see Multiple Retrieve.

Single Entity Route​

To retrieve a single record by its ID, use the singular form of the entity name followed by the ID. For example, to get the company with ID 4:

http[s]://deepserhost/api/rest/company/4

This returns all fields of that specific company record.