Retrieves detailed information about a specific company by their ID.

GET 
/api/company/:company_id

Retrieves detailed information about a specific company by their ID.

Request

Path Parameters

company_id uuidrequired

The id of the company

Responses

200

Detailed information about the company

application/json

Schema

Schema

id uuidrequired

The unique identifier of the company.

name stringrequired

The name of the company.

description stringrequired

The description of the company. Can be null.

avatar urlrequired

The URL of the company avatar.

categories CampaignCategory[]required

Possible values: [art_and_design, automobiles, beauty, beverages, books_and_literature, career_and_business, children_toys_and_games, diy, e_commerce, education, events_and_entertainment, fashion, finance_and_insurance, food, gardening_and_outdoor, health_and_fitness, hobbies_and_crafts, home_and_living, home_appliences, legal_services, mobile_games, news, non_profit_and_charity, office_supplies, parenting_and_family_products, personal_development, pets, photography, podcasts, real_estate, social_media_tools, sports_and_outdoor_activities, streaming, subscription_box, technology, travel, video_games, wedding]

The categories of the company.

home_page urlrequired

Company website

monthly_budget stringrequired

Monthly budget in USD

year_of_foundation integerrequired

Year of foundation

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "avatar": "string",
  "categories": [
    "art_and_design"
  ],
  "home_page": "string",
  "monthly_budget": "string",
  "year_of_foundation": 0
}

404

Company not found

default

Unexpected error

application/json

Schema

Schema

code int32required

The error code

message stringrequired

A human-readable error message

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...