Companies

The Company object represents your Custom Trades CRM company account.

View as Markdown

Endpoints

GET/api/v1/companies/me

The Company object

Attributes

uuidstring

Unique identifier for the company

namestring

Company name

emailstring

Primary email address

phonestring |null

Primary phone number

address_line_1string |null

First line of address

address_line_2string |null

Second line of address

citystring |null

City

statestring |null

State or province

postal_codestring |null

Postal or ZIP code

countrystring |null

Country code

View as Markdown

THE COMPANY OBJECT

{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "Acme Plumbing",
"email": "contact@acme.com",
"phone": "+1-555-123-4567",
"address_line_1": "123 Main St",
"address_line_2": "Suite 100",
"city": "Seattle",
"state": "WA",
"postal_code": "98101",
"country": "US"
}

List Company

Returns the company associated with the authenticated API key.

Error codes

HTTP status codeDescription
200Success
401Unauthorized (invalid API key)
403Forbidden (add-on required, IP restriction, or usage limit exceeded)
404Company not found
GET/api/v1/companies/me
curl -G \
https://customtradescrm.com/api/v1/companies/me \
-H "Authorization: Bearer ctc_live_..."

Response

{
"success": true,
"data": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "Acme Plumbing",
"email": "contact@acme.com",
"phone": "+1-555-123-4567",
"address_line_1": "123 Main St",
"address_line_2": "Suite 100",
"city": "Seattle",
"state": "WA",
"postal_code": "98101",
"country": "US"
}
}