Pular para o conteúdo

Get Company

GET

/api/v1/companies/{company_id}

API de Produção

Get a specific company by ID.

Authorizations

HTTPBearer

Parameters

Path Parameters

company_id

required

Company Id

integer

Header Parameters

x-tenant-id

Any of:

integer
null

integer

Responses

200

Successful Response

CompanyResponse

Schema for company response.

object

name

required

Name

string

legal_name

Any of:

string
null

string

cnpj

Any of:

string
null

string

email

Any of:

string
null

string format: email

phone

Any of:

string
null

string

website

Any of:

string
null

string

address_line1

Any of:

string
null

string

address_line2

Any of:

string
null

string

city

Any of:

string
null

string

state

Any of:

string
null

string

postal_code

Any of:

string
null

string

country

Any of:

string
null

string

industry

Any of:

string
null

string

company_size

Any of:

string
null

string

annual_revenue

Any of:

number
null

number

logo_url

Any of:

string
null

string

tags

Any of:

string
null

string

status

Status

string

default: lead

source

Any of:

string
null

string

notes

Any of:

string
null

string

owner_id

Any of:

integer
null

integer

id

required

Id

integer

is_active

required

Is Active

boolean

last_contact_date

Any of:

string
null

string format: date-time

contract_start_date

Any of:

string
null

string format: date-time

contract_end_date

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

Any of:

string
null

string format: date-time

contacts_count

Any of:

integer
null

integer

custom_fields

Any of:

object
null

object

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string