Public API endpoints follow the format /<resource>.<verb>. An API endpoint typically operates on the resource and returns one or more instances of the resource(s) operated on.

Verbs

.info

Returns a single instance of the resource.

Example

/application.info returns a single application.

.list

Returns all of that resource in the collection, matching the specified filter. Endpoints using this verb are paginated and are intended to be used to sync all records in the associated collection.

Example

/application.list returns (one page at a time) all applications accessible to the caller.

.search

Returns all of that resource in the collection that match a "search query." Endpoints using this verb are not paginated and are intended for applications intending to make quick and specific lookups using relatively specific search terms.
Note: .list and .search are similar. The main difference is intended use case and pagination, though it's possible a use case for paginated search the public API could arise.

Example

/candidate.search returns candidates matching an email or name.

.[action]

Performs an action on the specified resource and returns the updated resource.

Example

/application.create creates a new application and returns it.