Skip to main content

Get Companies

GET 
/companies/portal/v1

Get Companies

Request​

Header Parameters

    X-API-KEY stringrequired

    API Key

Responses​

OK

Schema

  • Array [

    • description string

    Description is the description of the company

    external_identifier string

    ExternalIdentifier is a unique identifier of the company across the workspace for easy reference and avoiding duplicates. this can be the company's ID in any external system

    id string

    ID is the unique identifier of the company

    name string

    CreatedAt is the time the company was created

    revenue number

    Revenue is the revenue of the company, it's existance and validations depend on the whether the workspace is B2B or B2C

  • ]

Loading...