Company

GET api/companies

Return the list of companies

get/api/companies

Request

  • Base URL
    https://app.followr.ai
  • Auth
    HTTP bearer

Query parameters

includestring

additional relations to include in response, separated by semi-colon.

Example:image.thumbnail
filter[id]string

filter by id

Example:consequatur
filter[type]string

filter by type (company, individual)

Example:consequatur
filter[name]string

filter by name

Example:consequatur
filter[user_id]string

filter by user id

Example:consequatur
filter[country_iso_code]integer

filter by country iso code

Example:17
filter[language_iso_code]string

filter by language iso code

Example:consequatur
sortstring

sort by field.

Example:id, -id, name, -name, created_at, -created_at
page[number]integer

page number.

Example:1
page[size]integer

items per page (default 30).

Example:10

Response

Example response

{
  "data": [
    {
      "id": 120,
      "user_id": 271,
      "type": "company",
      "name": "Mueller-Dibbert",
      "description": "Dolores minus voluptatem quisquam quibusdam sed vel a.",
      "country_iso_code": "MU",
      "language_iso_code": "es",
      "language": "sg",
      "language_types": null,
      "interests": null,
      "tones": null,
      "emotions": null,
      "syntaxes": null,
      "characters": null,
      "fonts": null,
      "audience_types": null,
      "audience_ages": null,
      "audience_genders": null,
      "website": null,
      "palettes": null,
      "social_network_prompts": null,
      "ai_image_styles": null,
      "ai_preferences": null,
      "ai_keys": null,
      "webhook_secret": null,
      "webhook_posts_url": null,
      "created_at": "2025-09-18T23:53:42.000000Z",
      "updated_at": "2025-09-18T23:53:42.000000Z",
      "disabled_at": null,
      "user": {
        "id": 271,
        "name": "Mrs. Audra Nolan",
        "email": "kunde.eloisa@example.com",
        "referral_code": "XHLUPT",
        "language": null,
        "timezone": null,
        "notification_settings": null,
        "credits": 0,
        "pm_type": null,
        "pm_last_four": null,
        "cancel_reason": null,
        "referrer_url": null,
        "land_url": null,
        "has_password": true,
        "created_at": "2025-09-18T23:53:42.000000Z",
        "updated_at": "2025-09-18T23:53:42.000000Z",
        "banned_at": null,
        "password_changed_at": "2025-09-18T23:53:42.000000Z"
      }
    },
    {
      "id": 121,
      "user_id": 272,
      "type": "company",
      "name": "Douglas Group",
      "description": "Perferendis voluptatibus incidunt nostrum quia possimus.",
      "country_iso_code": "MF",
      "language_iso_code": "ve",
      "language": "lb",
      "language_types": null,
      "interests": null,
      "tones": null,
      "emotions": null,
      "syntaxes": null,
      "characters": null,
      "fonts": null,
      "audience_types": null,
      "audience_ages": null,
      "audience_genders": null,
      "website": null,
      "palettes": null,
      "social_network_prompts": null,
      "ai_image_styles": null,
      "ai_preferences": null,
      "ai_keys": null,
      "webhook_secret": null,
      "webhook_posts_url": null,
      "created_at": "2025-09-18T23:53:42.000000Z",
      "updated_at": "2025-09-18T23:53:42.000000Z",
      "disabled_at": null,
      "user": {
        "id": 272,
        "name": "Mona Morissette",
        "email": "ablanda@example.org",
        "referral_code": "EKHH8J",
        "language": null,
        "timezone": null,
        "notification_settings": null,
        "credits": 0,
        "pm_type": null,
        "pm_last_four": null,
        "cancel_reason": null,
        "referrer_url": null,
        "land_url": null,
        "has_password": true,
        "created_at": "2025-09-18T23:53:42.000000Z",
        "updated_at": "2025-09-18T23:53:42.000000Z",
        "banned_at": null,
        "password_changed_at": "2025-09-18T23:53:42.000000Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.