Company Lists

List Company Lists

Changed on

Retrieve all company lists for the current team including list name, company count, and creation date. Use it to find a list's ID before reading its companies, adding companies to it or renaming it.

get/v0/company_lists

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/company_lists
  • Auth
    HTTP bearer

Response

Successful Response

namestring required

Name of the company list

idinteger required
created_atstring date-time required
deletableboolean nullable

Whether the list can be deleted

companies_countinteger

Number of companies in the list

user_idinteger nullable

User ID of the list owner

type'REVEALED_COMPANIES' | 'WEBHOOK_TRIGGERED' | 'MANUAL_CREATION' | 'EXPORT_SNAPSHOT' | 'INTERNAL_WEBHOOK_TRIGGERED' | 'CUSTOMER_CRM_SYNC'
webhook_idinteger nullable

Webhook ID of the list

customer_crm_connection_idinteger nullable

CRM connection that keeps this list in sync (CUSTOMER_CRM_SYNC lists)

Changes

  • 419602bcfbf6Revision changes
    • warning

      added the new CUSTOMER_CRM_SYNC enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

  • acc7d199f39aRevision changes
    • warning

      added the new INTERNAL_WEBHOOK_TRIGGERED enum value to the // response property for the response status