companies
GET {{api_url}}/api/v1/companies
Returns the list of companies in Userlot.
You optionally provide some additional parameters that filter down the returned list of companies.
These include our standard external ID attributes
external_id- The ID matching your internal ID in your productsource_external_id- An ID of an external system such as a CRM or ticketing system.
If you want to look up via Userlot's ID, please use the /:id endpoint
Optionaly you can also provide id's that match below to further limit the returned set of companies.
- Userlot team user owner
- Life Cycle
- Life Cycle State
- Account status
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
name | null | Filter the returned set by name | |
external_id | null | Filter the returned set by the ID in your SAAS product | |
source_external_id | null | Filter the returned set by an ID associated with another external sytem | |
owner_user_id | null | Filter the returned set that are owned by a particluar Userlot team member | |
life_cycle_id | null | Filter the returned set by specific Life Cycle | |
life_cycle_stage_id | null | Filter the returned set by a specific Life Cycle Stage | |
status_id | null | Filter the returned set by a specific status |
RESPONSES
status: OK
[{"id":"f7d54b32-b421-48f2-abf2-baaedd257f30","created_at":"2022-12-05T04:51:54Z","updated_at":"2022-12-05T04:51:54Z","friendly_id":2,"name":"Demo","emails":[],"health_score":0,"health_score_diff":null,"last_seen_at":"2023-02-06T04:56:33Z","health_category":null,"owner_user_id":null,"mrr":null,"arr":null,"start_date":null,"renewal_date":null,"life_cycle_stage_id":"8dea5e21-ac4f-469e-b9b5-29d2f987bb39","status_id":"65e822e0-4ac2-4708-b34b-7e19a2692643","life_cycle_id":"56857a2e-87b4-4f5f-967f-b7ff9c42af1b","external_id":"106042c0-32a5-4e63-b421-dee3ba898199"}]