> ## Documentation Index > Fetch the complete documentation index at: https://docs.augment.market/llms.txt > Use this file to discover all available pages before exploring further. # List companies > Returns a paginated list of companies ## OpenAPI ````yaml /openapi.generated.json get /api/v1/companies openapi: 3.0.3 info: title: Augment External API version: 1.0.0 description: > Public, API-key-authenticated read surface for Augment company and offering data. servers: - url: https://developer.augment.market - url: https://xxe4toqf29.execute-api.us-west-2.amazonaws.com/dev-ethan security: [] paths: /api/v1/companies: get: tags: - external-api-v1 summary: List companies description: Returns a paginated list of companies operationId: listExternalApiCompanies parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' - name: company_id in: query description: An array of company IDs by which to filter required: false schema: type: array items: type: integer style: form explode: true - name: category_slug in: query description: An array of category slugs by which to filter required: false schema: type: array items: type: string style: form explode: true responses: '200': description: A paginated list of companies content: application/json: schema: $ref: '#/components/schemas/CompanyList' example: companies: - id: 42 name: Acme Robotics normalized_name: acme-robotics legal_name: Acme Robotics, Inc. domain: acmerobotics.com description: Builds warehouse automation robots. logo_filename: acme-robotics.png logo_color: '#1A73E8' ticker: ACME founded_year: 2015 location: San Francisco, CA categories: - id: 3 slug: robotics name: Robotics created_at: '2024-01-10T00:00:00Z' updated_at: '2025-01-15T12:00:00Z' page_info: limit: 25 offset: 0 total_count: 1 has_next: false '400': $ref: '#/components/responses/ErrorBadRequest' '401': $ref: '#/components/responses/ErrorUnauthorized' '403': $ref: '#/components/responses/ErrorForbidden' '429': $ref: '#/components/responses/ErrorRateLimited' '500': $ref: '#/components/responses/ErrorInternalError' '503': $ref: '#/components/responses/ErrorServiceUnavailable' security: - ApiKeyAuth: [] components: parameters: Limit: name: limit in: query description: Maximum number of elements to return required: false schema: type: integer example: 25 Offset: name: offset in: query description: Number of elements to skip before collecting the result set required: false schema: type: integer example: 50 schemas: CompanyList: type: object description: A paginated window of companies properties: companies: type: array items: $ref: '#/components/schemas/CompanySummary' page_info: $ref: '#/components/schemas/PageInfo' required: - companies - page_info additionalProperties: false CompanySummary: type: object description: Identity and description view of a company properties: id: type: integer description: Company identifier name: type: string description: Company display name normalized_name: type: string description: URL-safe normalized company name legal_name: type: string description: Registered legal name of the company domain: type: string description: Primary web domain of the company description: type: string description: Description of what the company does logo_filename: type: string description: Filename of the company logo asset logo_color: type: string description: Brand colour associated with the company logo ticker: type: string description: Short ticker-style company abbreviation founded_year: type: integer description: Year the company was founded location: type: string description: Headquarters location of the company categories: type: array description: Categories the company belongs to items: $ref: '#/components/schemas/CompanyCategory' created_at: type: string format: date-time description: When the company record was created updated_at: type: string format: date-time description: When the company record was last updated required: - id - name - normalized_name - legal_name - domain - description - logo_filename - logo_color - ticker - founded_year - location - categories - created_at - updated_at additionalProperties: false PageInfo: type: object description: Pagination metadata describing the returned window of results properties: limit: type: integer format: int64 description: Maximum number of elements returned offset: type: integer format: int64 description: Number of elements skipped before this window total_count: type: integer format: int64 description: Total number of elements matching the request has_next: type: boolean description: Whether a following window exists required: - limit - offset - total_count - has_next additionalProperties: false example: limit: 25 offset: 50 total_count: 137 has_next: true ErrorEnvelope: type: object description: Error body returned by every failing response properties: error: type: string description: Human-readable error message code: $ref: '#/components/schemas/ErrorCode' required: - error - code additionalProperties: false CompanyCategory: type: object description: A category a company belongs to properties: id: type: integer description: Category identifier slug: type: string description: URL-safe category identifier name: type: string description: Display name of the category required: - id - slug - name additionalProperties: false ErrorCode: type: string description: > Machine-readable error code. Mirrors external/domain/errors.go exactly; the wire strings are part of the public contract and must not drift from that file. enum: - unauthenticated - invalid_key - key_revoked - insufficient_scope - client_suspended - not_found - invalid_parameter - rate_limited - service_unavailable - internal_error responses: ErrorBadRequest: description: Invalid request parameter content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: Invalid request parameter code: invalid_parameter ErrorUnauthorized: description: Missing, invalid, or revoked API credentials content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: Missing API credentials code: unauthenticated ErrorForbidden: description: The API key lacks the required scope, or the client is suspended content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: API key does not grant the required scope code: insufficient_scope ErrorRateLimited: description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: Too many requests, please try again later code: rate_limited ErrorInternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: Internal server error code: internal_error ErrorServiceUnavailable: description: The service is temporarily unavailable; retry later content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: Service temporarily unavailable, please try again later code: service_unavailable securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: > The API key issued to your client. Send it on every request; a missing, unrecognised, or revoked key is rejected with 401. ````