Companies

This resource represents a company in your workspace.

Note that some companies are placeholder companies, where the name = "" and isPlaceholder = true. Placeholder companies are automatically created when a client is created without an association to a "named" company.

If a client is created under a named company and later un-assigned from that company, a new placeholder company will be created and the companyId will be a new ID.

Properties

id string The unique identifier for this item.

createdAt string The date this item was created in RFC3339 format.

object string The object type of this resource.

name string The company's name.

isPlaceholder bool Designates if the company is a placeholder (see note above).

iconImageUrl string A link to the company's icon image.

fallbackColor string Background color for company avatar when no icon image is present.

customFields map The company’s custom field values.

The key is the key of the custom field property, and the value is the company’s custom field value.

Note: this will be null if the company has no custom fields set.

{
    "id": "4bab7a19-d99c-4917-bda9-33bc7c37ed2d",
    "object": "company",
    "createdAt": "2025-09-29T17:48:46.358534959Z",
    "name": "Assembly",
    "fallbackColor": "#EC4E20",
    "iconImageUrl": "https://lightout-portal.s3-accelerate.amazonaws.com/public/b1VRvR-zM/images/profile_pictures/7f4331ef-101b-4248-9c74-3337661b1821/2246c44d-d76a-4504-b197-ce537552283e",
    "isPlaceholder": false,
    "customFields": {
        "address": {
            "addressLine1": "903 Broadway",
            "addressLine2": null,
            "city": "New York",
            "country": "US",
            "fullAddress": "903 Broadway\nNew York, New York, 10010\nUnited States",
            "postalCode": "10010",
            "region": "New York"
        },
        "email": "[email protected]",
        "number": "001",
        "phoneNumber": "+19175555555",
        "tags": [
            "sampleTag1",
            "sampleTag2"
        ],
        "text": "Sample text custom field",
        "url": "https://assembly.com"
    }
}