Prepare to do a find/search operation on companies

get

/api/v4/company/preparefind

This endpoint provides meta-information to authorized users. After retrieving this information, the client (for example, JavaScript code running in a web browser) can use this information to directly access the Find API (/token/api/v4/company/find endpoint) to do a search.
The output is a JSON map with one parameter called "Key". This key should be used when calling the Find API.

Versions Supported:

v4

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: object

500 Response

An unexpected error occurred during the request.
Body ()
Root Schema : schema
Type: object
Back to Top

Examples

Example Request:

/api/v4/company/preparefind

Example Response:

{
   "Key": "JDHRO25GHDSLVMFFS"
}
Back to Top