Skip to main content
GET
/
companies
List companies
curl --request GET \
  --url https://www.useroulette.com/api/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "companies": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "account_id": "11111111-2222-3333-4444-555555555555",
        "name": "Acme Technologies",
        "deck_link": "https://docsend.com/view/example123",
        "visibility": "team",
        "source": "form",
        "company_status_id": null,
        "notes": "Met at TechCrunch Disrupt 2024",
        "created_at": "2024-01-15T10:30:00.000000+00:00",
        "updated_at": "2024-01-15T12:45:00.000000+00:00",
        "created_by": "user-uuid-1234",
        "updated_by": "user-uuid-1234",
        "assignees": [],
        "company_status": null,
        "metadata": {
          "founders": [
            {
              "name": "Jane Smith",
              "email": "jane@example.com",
              "title": "CEO/Co-Founder",
              "linkedin_profile": "https://www.linkedin.com/in/example/"
            }
          ],
          "ai_analysis": "B2B SaaS platform for enterprise workflow automation...",
          "analyzed_at": "2024-01-15T12:45:00.000Z",
          "user_preferences": [
            {
              "type": "text",
              "field": "Website",
              "value": "https://example.com",
              "options": [],
              "show_in_table": true
            }
          ]
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 25,
      "has_next": true,
      "has_prev": false
    }
  },
  "authType": "api_key"
}

Documentation Index

Fetch the complete documentation index at: https://docs.useroulette.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication. Generate keys from your account settings.

Include in header: Authorization: Bearer YOUR_API_KEY

Query Parameters

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
limit
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
sort_by
enum<string>
default:created_at

Field to sort results by

Available options:
created_at,
updated_at,
name
​
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
search
string

Full-text search query

Required string length: 1 - 500
​
visibility
enum<string>

Filter by visibility level

Available options:
private,
shared,
team
​
source
enum<string>

Filter by source

Available options:
manual,
email,
form,
referral,
website,
event,
other
​
company_status_id
string

Filter by status ID. Use 'no_status' for companies without a status.

​
include_pdf_url
boolean
default:false

Include signed download URLs for pitch deck PDFs

Response

Successful response

​
success
boolean
required
Example:

true

​
data
object
required
​
authType
enum<string>

Authentication method used for this request

Available options:
api_key,
session