Company
List all existing companies
get/v1/companies
Request
- Base URLhttps://api.infoset.app (the document declares no server; this is the origin it was published from)
- Auth
- HTTP bearer
- or API key in header X-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Idinteger
DepartmentIdinteger
Namestring
Emailstring
Phonestring
Example:12124567890
Phone number with country code, without leading + (plus) sign, minimum 4 digits or empty. Items having a phone number that starts with the given value will be returned.
Addressstring
Statestring
Citystring
Townstring
Webstring
CountryCodestring
FromCreatedDatestring
ToCreatedDatestring
CustomFieldsobject
Qstring
Fieldsstring
DepartmentScopeDepartment
Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.
ViewType0 | 1
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul><p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
Pageinteger
ItemsPerPageinteger
ReturnTotalItemsboolean
sortColstring
sortDirstring
isExportboolean
Response
OK
Example response
{
"items": [
{
"name": "Acme Inc",
"email": "info@acmeinc.com",
"phone": "12124567890",
"web": "acmeinc.com",
"countryCode": "US"
}
]
}Changes
No recorded changes to this operation across all 3 revisions of this API.