Search for companies
- 16 Jul 2024
- 3 Minutes to read
- Print
Search for companies
- Updated on 16 Jul 2024
- 3 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/SearchCompanies
Allows you to search for companies.
Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
pageSize
integer (int32)
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
sort
string
The value you want to sort by. If not supplied, a default value of "Name" will be used. You can append " DESC" after the sort value to sort descending. For example, "Name DESC" would sort by name in descending order. Possible values:
- Name
- OrganizationName
- ExternalId
- Created
- LastModified
name
string
An optional parameter used to filter for companies by name. When specified, only companies that have names that contain or match this value will be returned.
externalId
string
An optional parameter used to filter for a company by external ID. Specifying the unique External ID paramter value will only ever return a single matching result.
organizationId
integer (int32)
An optional parameter used to filter companies by the associated organization id. When specified, only the companies associated with this organization will be returned.
createdAfter
string
An optional parameter used to filter for companies created after a specified date. When used in conjunction with the "createdBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
createdBefore
string
An optional parameter used to filter for companies created before a specified date. When used in conjunction with the "createdAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
lastModifiedAfter
string
An optional parameter used to filter for companies modified after a specified date. When used in conjunction with the "lastModifiedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
lastModifiedBefore
string
An optional parameter used to filter for companies modified before a specified date. When used in conjunction with the "lastModifiedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Responses
200
OK Response
object
TotalCount
integer (int32)
The total number of results that match the search conditions, not all of which may be in the current result set.
Example1
TotalPages
integer (int32)
The total number of result pages that match the search conditions.
Example1
Companies
Array of object (Companies)
See Companies results.
object
Id
integer (int32)
The company's unique identifier.
Example123456789
OrganizationId
integer (int32)
The Id of the Organization associated with this company
Example951624
OrganizationName
string
The Name of the Organization associated with this company
ExampleABC Organization
Name
string
The Name of the company
ExampleABC Training Company
Description
string | null
The Description of the company
ExampleThe Description of the company
ExternalId
string | null
The External Id of the company
Examplecmp123456
Address1
string | null
The first Address line for a Company
ExampleSome street
Address2
string | null
The second Address line for a Company
ExampleSome avenue
City
string | null
The City for a Company
ExampleGrand Rapids
State
string | null
The State for a Company (recommended use standard 2-character abbreviation, limit 50 characters)
ExampleMI
Zip
string | null
The Zip code for a Company
Example123456
Country
string | null
The Country for a Company (recommended use standard 2-character abbreviation, limit 80 characters)
ExampleUS
Email
string | null
The Email address for a Company
Examplesomeemail@abccompany.com
Phone
string | null
The Phone number for a Company
Example123-456-7890
Phone2
string | null
The alternate Phone number for a Company
Example555-654-9870
Fax
string | null
The Fax number for a Company
Example555-555-5555
WebSiteUrl
string | null
The Web Site Url for a Company
Examplehttps://sampleurl.com
Created
integer (int64)
When the Company was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1449496820
LastModified
integer (int64)
When the Company was last modified. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1584035105
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
Was this article helpful?