---
title: "Get the company profile"
method: GET
path: "/v1/company"
tags: ["Company"]
---

# Get the company profile

`GET /v1/company`

## Request

- Base URL: `https://api.rumoro.dev`
- URL: `https://api.rumoro.dev/v1/company`
- Auth: HTTP bearer

Returns what the classifier knows about your company. That is the name, description, use cases and your accounts, plus the context text built from them.

## Response `200`

Your company profile

- Company
  - `name` string, required: The name of your brand or company, as the classifier should use it.
  - `description` string, required: A paragraph on what the company does.
  - `useCases` string[], required: Typical uses of the product.
  - `accounts` object, required: Your company's accounts, so posts from them are recognized as yours.
    - `x` string, nullable, required: Your X handle, without @.
    - `linkedin` string, nullable, required: Your LinkedIn page, as its slug or link.
  - `website` string, nullable, required: The company's website, as entered during onboarding.
  - `competitors` string[], required: Names of competitors, so the classifier knows when a post is about one of them. Often the same names as your competitor keywords.
  - `guidelines` string, nullable, required: Rules for the classifier in your own words, saying what is relevant to you and what never is, for example "questions about our SDK, never job ads". After the description, this has the most effect on scores.
  - `context` string, required: Classifier input. Built from the other fields unless you write it yourself.

## Other responses

- `401`: The API key is missing or not valid
- `404`: The workspace does not exist

---

[API](https://skmtc.dev/rumoro/apis/rumoro-api.md) · [All operations](https://skmtc.dev/rumoro/apis/rumoro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rumoro/apis/rumoro-api/revisions/9ef63ea894d1?raw)