Allows you to search for companies.
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).
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
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
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.
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.
An optional parameter used to filter companies by the associated organization id. When specified, only the companies associated with this organization will be returned.
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.
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.
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.
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.
OK Response
The total number of results that match the search conditions, not all of which may be in the current result set.
The total number of result pages that match the search conditions.
See Companies results.
The company's unique identifier.
The Id of the Organization associated with this company
The Name of the Organization associated with this company
The Name of the company
The Description of the company
The External Id of the company
The first Address line for a Company
The second Address line for a Company
The City for a Company
The State for a Company (recommended use standard 2-character abbreviation, limit 50 characters)
The Zip code for a Company
The Country for a Company (recommended use standard 2-character abbreviation, limit 80 characters)
The Email address for a Company
The Phone number for a Company
The alternate Phone number for a Company
The Fax number for a Company
The Web Site Url for a Company
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.
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.
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).