> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinyellowbrick.com/llms.txt > Use this file to discover all available pages before exploring further. # Search companies and authors > High-level entity search across Yellowbrick. `q` matches author username and display name, and company ticker, legal name, and alternate names. It does not search pitch text. Take `authors[].username` and `companies[].companyId` and pass them to GET /api/v1/pitches. ## OpenAPI ````yaml /openapi.json get /api/v1/search openapi: 3.1.0 info: title: Yellowbrick API version: 1.0.0 description: >- Find companies and authors, read the tag vocabulary, reuse saved filter sets, then list or fetch pitches. The key identifies a Premium account. That account's access still applies on every request. servers: - url: https://www.joinyellowbrick.com description: Production - url: https://yellowbrick-staging.vercel.app description: Staging security: - bearerAuth: [] tags: - name: Search description: >- Look up companies and authors by name, ticker, username, or display name. Use the ids you get on the pitch list. - name: Tags description: >- Catalog of filter slugs and type keys, including author badge, author return, win rate, and pitch return. Send `slug` as `extraTags` or use the typed pitch-list parameters. - name: Filter Sets description: >- Saved tag combinations on the key owner's account. Pass an `id` as `filterSetIds` on the pitch list. - name: Pitches description: >- List write-ups that match search ids, tags, and filter sets, or fetch one pitch by id. paths: /api/v1/search: get: tags: - Search summary: Search companies and authors description: >- High-level entity search across Yellowbrick. `q` matches author username and display name, and company ticker, legal name, and alternate names. It does not search pitch text. Take `authors[].username` and `companies[].companyId` and pass them to GET /api/v1/pitches. operationId: searchEntities parameters: - name: x-vercel-protection-bypass in: query required: false description: >- Optional. Vercel Protection Bypass for Automation — use when calling the Staging server. schema: type: string - name: q in: query required: true description: >- At least 2 characters. Matches authors by username or display name, and companies by ticker, legal name, or alternate name. Use the returned `username` and `companyId` on GET /api/v1/pitches. schema: type: string minLength: 2 description: >- At least 2 characters. Matches authors by username or display name, and companies by ticker, legal name, or alternate name. Use the returned `username` and `companyId` on GET /api/v1/pitches. - name: limit in: query required: false description: >- Maximum results across both lists. About three quarters go to companies; the rest go to authors. Default 16, maximum 30. schema: default: 16 description: >- Maximum results across both lists. About three quarters go to companies; the rest go to authors. Default 16, maximum 30. type: integer exclusiveMinimum: 0 maximum: 30 responses: '200': description: Matching authors and companies content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: authors: type: array items: type: object properties: userId: type: string description: Author user id. username: type: string description: >- Username without `@`. Pass as `authorUsername` on GET /api/v1/pitches. displayName: type: string description: Public display name. profileImageUri: type: - string - 'null' tier: description: Author tier, such as Elite or Rising. type: - string - 'null' required: - userId - username - displayName - profileImageUri - tier additionalProperties: false companies: type: array items: type: object properties: companyId: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Company id. Pass as `companyId` on GET /api/v1/pitches. tradingItemId: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Primary listing id for this company. companyName: type: string ticker: type: string description: Primary ticker symbol. exchangeSymbol: type: - string - 'null' exchangeCountryIso2: type: - string - 'null' required: - companyId - tradingItemId - companyName - ticker - exchangeSymbol - exchangeCountryIso2 additionalProperties: false required: - authors - companies additionalProperties: false '400': description: Problem details (`type`, `title`, `status`, `detail`). content: application/problem+json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: type: type: string description: Stable error code, such as `premium-required`. title: type: string description: Short label for the error. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code. detail: type: string description: Human-readable explanation. required: - type - title - status - detail additionalProperties: false '401': description: Problem details (`type`, `title`, `status`, `detail`). content: application/problem+json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: type: type: string description: Stable error code, such as `premium-required`. title: type: string description: Short label for the error. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code. detail: type: string description: Human-readable explanation. required: - type - title - status - detail additionalProperties: false '403': description: Problem details (`type`, `title`, `status`, `detail`). content: application/problem+json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: type: type: string description: Stable error code, such as `premium-required`. title: type: string description: Short label for the error. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code. detail: type: string description: Human-readable explanation. required: - type - title - status - detail additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: 'Key from Profile. Send `Authorization: Bearer yb_...`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.