Endpoints

Async Job - Request Organizations Exposures

post
https://api.clarity.ai/clarity/v1/public/organizations/exposures/exposures-by-id/async

This endpoint will make a request for an async job to retrieve Clarity.AI organizations exposures for given exposure ids.
You can request the whole exposures universe (all organizations) or provide a list of organization permIds (see: permid.org).Please note: This call returns only the identifier (UUID) for the created job. You'll need this value later on further calls to know the status of your job (see Async Job - Get job status) or download your file when ready (see «Async Job - Download result file»)
Check this document for a complete explanation of the flow for these async jobs endpoints

Body Params
exposureIds
array of strings

Requested exposure ids

exposureIds
permIds
array of strings

List of organizations, identified by permId, to retrieve information from. If this parameter is not present, all available organizations will be returned

permIds
boolean
Defaults to false

Include minimum and maximum revenue percentages for each exposure in the downloaded file

string | null
enum
Defaults to boolean

Changes the type of the exposure flags returned in the response, from the default boolean values (TRUE/FALSE) to integer values (0/100), where 0 means the company is not exposed and 100 means it is exposed

Allowed:
Responses

Updated 2 minutes ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 minutes ago