ROrocketlane
Companies

Get company by Id

Changed on
get/1.0/companies/{companyId}

Request

Path parameters

companyIdinteger required

The company's unique, system-generated identifier, which can be used to identify the company globally.

Query parameters

includeFieldsstring[]

Use this query parameter to opt in for companies to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Response

The requested action was successfully executed.

companyIdinteger

The company's unique, system-generated identifier, which can be used to identify the company globally.

companyNamestring

The name of the company.

companyUrlstring

The URL of the client's website. Unless explicitly stated, the value for this field can be left blank.

visibility'EVERYONE' | 'MEMBERS' | 'GROUP' | 'EVERYONE' | 'MEMBERS' | 'GROUP'

Visibility of the company. Allowed values: EVERYONE, MEMBERS, and GROUP. Create/update via the Public API only accept EVERYONE and MEMBERS (same as projects); GROUP may appear in responses when set through other product flows.

createdAtinteger

The time when the company was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the company was updated. The referenced time will be in epoch millis.

descriptionstring

A detailed description or notes about the company. Useful for storing organizational context, business details, or internal notes.

Example response

{
  "companyId": 201,
  "companyName": "Acme Inc",
  "companyUrl": "https://www.acme.com",
  "visibility": "EVERYONE",
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "description": "Leading software development partner for enterprise solutions",
  "accountOwner": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValue": "1000",
      "fieldValueLabel": "1000"
    }
  ],
  "notes": [
    {
      "noteId": 1,
      "fieldId": 44,
      "fieldLabel": "Account Notes",
      "noteTitle": "Q1 Planning Discussion",
      "noteText": "Initial contact: discussed Q1 roadmap and pricing",
      "tags": [
        {
          "tagId": 1,
          "label": "sales",
          "color": "blue"
        }
      ],
      "createdAt": 1750343334605,
      "updatedAt": 1750343334570
    }
  ]
}

Changes