Skip to main content
An API key acts as one organization. These endpoints return that organization’s profile: its ID, name, primary domain, industry, country, size, contact email and logo. Call them to confirm which organization a key acts as, and to label the data your integration collects.
Organizations are managed in the dashboard, which calls them workspaces. Your own workspace’s details open from its name at the top of the sidebar, and its plan and usage are under Manage. System Admins and System Users manage client workspaces under Manage → Workspaces. The API has no endpoint to create, edit or delete an organization.
Availability: every plan with an API Calls allowance. These endpoints check no plan feature and no license. They answer even when the organization has no license in force. Cost: 1 unit of your monthly API Calls allowance per call. The unit is refunded if the response is not a 2xx. No feature allowance applies. Every call also counts toward the per-second rate limit. These endpoints never return the plan-feature or license 403, a feature-allowance 429 or a capacity 409. Two limits can refuse them: the per-second rate limit, and your monthly API Calls allowance once it is used up. Both return 429 with "message": "Rate limit exceeded". See Rate limits and Errors.

​
Read your organization

get_direct_org_info returns the organization the key belongs to. It takes no parameters.
Industry and size decide which peer organizations your leak counts are compared with on Risk and exposure. The peer average and median also match on country.
Integrations built before the editions release: the profile no longer returns license or used_credits. Its country carries code instead of id and can be null. country_list returns {code, name} instead of {id, name}. See the migration guide.

​
Check what your plan includes

The profile does not list plan features or allowances. To see them, open Manage → Buy more in the dashboard for the plan, and Manage → Usage for what is used and left. A call to a feature outside your plan returns 403:
How features, allowances and capacity work is explained once, on Plans and quotas. When other endpoints return 403 with "detail": "Your license is not active.", get_direct_org_info still answers. Use it to confirm that the key is valid and acts as the organization you expect.

​
Read by ID or as a list

Two more endpoints return the same profile shape. An API key reads only its own organization. organization_list returns a one-item array. organization_info returns the profile for your own id:
Any other ID returns 404:
Clients whose assets you register in your own organization share its profile. A client workspace has its own key: that key reads the client workspace’s profile, and its main_org_id is your organization’s id. See Client organizations.

​
Look up countries and industries

Two lookups list the values the profile can hold. country_list returns all 249 ISO 3166-1 countries as {code, name}, sorted by name in plain character order, so Åland Islands comes after Zimbabwe. It is paginated: 100 per page by default, up to 1,000 with page_size. Request page_size=300 to get every country in one page.
industry_type_list returns every industry as {id, name}, sorted by name, in one unpaginated array.

​
Endpoints