Search for companies or get a company by ID

GET /company

Retrieve details of a company by ID or search for companies based on a search term.

Query parameters

companyID integer
input string

Responses

200 application/json

A list of companies or the details of a single company
Hide response attributes Show response attributes object
- companyID integer
- status string
- name string
- streetAddress string
- route string
- city string
- state string
- postalCode string
- contactNumber string
- email string
- industry string
- description string
- website string
- size string
- referral string
- stripeCustomerID integer
- createdBy integer
- updatedBy integer
404

Company not found
500

Internal Server Error

GET /company

curl \
 -X GET http://api.example.com/company

Response examples (200)

[
  {
    "companyID": 42,
    "status": "string",
    "name": "string",
    "streetAddress": "string",
    "route": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "contactNumber": "string",
    "email": "string",
    "industry": "string",
    "description": "string",
    "website": "string",
    "size": "string",
    "referral": "string",
    "stripeCustomerID": 42,
    "createdBy": 42,
    "updatedBy": 42
  }
]