--- title: "Get all companies" method: GET path: "/1.0/companies" tags: ["Companies"] --- # Get all companies `GET /1.0/companies` ## Request - Base URL: `https://api.rocketlane.com/api` - URL: `https://api.rocketlane.com/api/1.0/companies` - Auth: API key in header `api-key` - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint can be used to search for companies. The response body is paginated and you can control the pagination using the `pageSize` and `pageToken` parameters. Native filters include companyName, companyUrl, and accountOwner. Custom company fields (including NOTE fields, treated as text) can be filtered with `company.field..operator=value`. ## Query parameters - `pageSize` number - `pageToken` string - `includeFields` string[] - `includeAllFields` boolean - `sortBy` 'companyName' | 'createdAt' | 'updatedAt' - `sortOrder` 'ASC' | 'DESC' - `match` 'all' | 'any' - `companyName.eq` string - `companyName.cn` string - `companyName.nc` string - `companyUrl.eq` string - `companyUrl.cn` string - `companyUrl.nc` string - `accountOwner.eq` string - `accountOwner.oneOf` string - `accountOwner.noneOf` string ## Response `200` The requested action was successfully executed. - ExampleAPIResponseCompanies - `data` CustomerCompanyPublicAPIResponseEntity[]: Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response. - `companyId` integer: The company's unique, system-generated identifier, which can be used to identify the company globally. - `companyName` string: The name of the company. - `companyUrl` string: 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. - `createdAt` integer: The time when the company was created. The referenced time will be in epoch millis. - `updatedAt` integer: The time when the company was updated. The referenced time will be in epoch millis. - `createdBy` CompanyCreatedByUserPublicAPI: The details of the user who created the company. - `emailId` string: The Email id of the user who created the company. - `userId` integer: The User id of the user who created the company. - `firstName` string: The first name of the user who created the company. - `lastName` string: The last name of the user who created the company. - `updatedBy` CompanyUpdatedByUserPublicAPI: The details of the user who last updated the company. - `emailId` string: The Email id of the user who last updated the company. - `userId` integer: The User id of the user who last updated the company. - `firstName` string: The first name of the user who last updated the company. - `lastName` string: The last name of the user who last updated the company. - `description` string: A detailed description or notes about the company. Useful for storing organizational context, business details, or internal notes. - `accountOwner` CompanyAccountOwnerPublicResponse: The account owner of the company. - `emailId` string: The Account owner's email identifier. - `userId` integer: The unique identifier for Account owner. - `firstName` string: The first name of the Account owner. - `lastName` string: The last name of the Account owner. - `fields` CompanyFieldPublicResponseAPIEntity[]: Custom fields associated with the company. - `fieldId` integer: The field identifier - `fieldLabel` string: The `fieldLabel` is the name of the custom Account field - `fieldValue` string: The `fieldValue` is the value provided while creation or updating. The fieldValue can be a string, an integer, or an number array and it must match the type of the field. Refer [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how each `field_type` is associated with project. - `fieldValueLabel` string: The `fieldValueLabel` is the value provided while creation or updating in a String format. - `notes` CompanyNotePublicResponseAPIEntity[]: Notes on note-type custom fields. Included when includeFields=notes. - `noteId` integer: Unique identifier of the note. - `fieldId` integer: ID of the note-type custom field this note belongs to. - `fieldLabel` string: Display name of the note-type field. - `noteTitle` string: Optional title of the note. - `noteText` string: Plain text content of the note. - `tags` CompanyNoteTagPublicResponseEntity[]: Tags selected for this note, resolved from the field's tag options. - `tagId` integer: The unique identifier of the tag - `label` string: The display label of the tag - `color` string: The color associated with the tag - `createdAt` integer: Unix timestamp in milliseconds when the note was created. - `updatedAt` integer: Unix timestamp in milliseconds when the note was last updated. - `pagination` ExamplePaginationCompanies: Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages. - `pageSize` integer: Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank. - `hasMore` boolean: Tells us if there is more content. - `totalRecordCount` integer: Denotes the total resources matching the filters. - `nextPage` string: Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page. - `nextPageToken` string: Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes. ## Other responses - `400`: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax. - `401`: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab. - `500`: This error denotes that there is an error that occured within our servers. The response body could help narrow down the cause for the error by our support team. ## Changes - **2026-11-03** `a002a499e6fc`: 1 info - endpoint added [Operation history](https://skmtc.dev/rocketlane/apis/rocketlane-api/changes/1.0/companies/get.md) --- [API](https://skmtc.dev/rocketlane/apis/rocketlane-api.md) - [All operations](https://skmtc.dev/rocketlane/apis/rocketlane-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rocketlane/apis/rocketlane-api/revisions/a002a499e6fc?raw)