Skip to main content
The Org logo
  • Category: sales & crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: THE_ORG
  • Version: 20261101_00

Tools

Slug: THE_ORG_ESTIMATE_POSITION_SEARCH_COSTEstimate the credits required for one page of a position search without consuming credits. Use the same limit, offset, and filters with Search Positions if the estimate is acceptable.

Input Parameters

integer
Prospective maximum rows for this page (1-1000, default 10, matching Search Positions); each returned row would cost 1 credit.
integer
Prospective result offset (0-10000).
object
required
Position filters to use for the free cost estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_GET_CURRENT_USAGEReturn the connected account’s current credit allowance, billing interval, reset date, additional credits, overages, and unlimited status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_GET_MANAGERWARNING: Each successful lookup costs 1 credit. Find a person’s org-chart manager by work email or LinkedIn profile URL.

Input Parameters

string
Person’s work email. Provide at least one of email or linked_in_url; prefer one because sending both is unverified.
string
Person’s LinkedIn profile URL. Provide at least one of linked_in_url or email; prefer one because sending both is unverified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_GET_ORG_CHARTReturn a company’s v1.2 org chart or board as a flat node list. A successful request costs 10 credits; metered REST requests can be replayed within 24 hours at no additional cost.

Input Parameters

string
Company website or email domain. Provide at least one of domain or linked_in_url; prefer one because sending both is unverified.
string ("orgChart" | "board")
Org-chart section to return. Use orgChart for the reporting hierarchy or board for board and advisor nodes; v1.2 does not support unplaced.
string
LinkedIn company URL or slug. Provide at least one of linked_in_url or domain; prefer one because sending both is unverified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_GET_USAGE_HISTORYReturn daily or monthly historical usage for one API product over an inclusive date range.

Input Parameters

string
required
Inclusive end date in YYYY-MM-DD format; must not be before from_date.
string ("daily" | "monthly")
Usage aggregation interval: daily or monthly.
string
required
Inclusive start date in YYYY-MM-DD format; must not be after to_date.
string ("embed_api" | "manager_api" | "prospecting_api" | "org_chart_api" | "data_api")
required
API product to inspect. The accepted values are embed_api, manager_api, prospecting_api, org_chart_api, and data_api.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_LIST_PEOPLE_LISTSReturn people and lead lists owned by or shared with the connected account, one page at a time.

Input Parameters

integer
Maximum lists to return in this page (1-100).
integer
Result offset. Pass the previous response’s next_offset to continue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_SEARCH_COMPANIESFind companies by name, domain, or email without consuming credits. Provide at least one search identifier; prefer one when possible.

Input Parameters

string
Email address whose company should be identified. Provide at least one of query, domain, or email; prefer one identifier when possible.
integer
Maximum companies to return (1-50).
string
Company name or free-text company query. Provide at least one of query, domain, or email; prefer one identifier when possible.
string
Company website or email domain. Provide at least one of query, domain, or email; prefer one identifier when possible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THE_ORG_SEARCH_POSITIONSSearch people and positions using company, role, hierarchy, location, funding, and contact filters, returning one page with a next_offset for continuation. Searches cost one credit per returned row, with repeat returns of the same row within 24 hours free.

Input Parameters

integer
Maximum rows to return and charge for in this page (1-1000, default 10). Each returned row costs 1 credit; prefer a small value and estimate first.
integer
Result offset (0-10000). For continuation, pass the previous response’s next_offset while keeping the same filters and limit.
object
required
Position filters for this search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not