ASDinCloudDocs
API ReferenceCompany profile

Company profile

View as Markdown

The company profile object

View as Markdown

The profile combines company settings with the primary contact when one is configured.

Attributes

companyobject
Company name, slug, and company settings.
primary_contactobject or null
The contact ID, given name, surname, and email.

Retrieve a company profile

View as Markdown
GET/api/v1/company-profile

Returns the company profile for your workspace.

Permissions

Send your API key in X-API-Key. Required permissions are Settings → Read.

Returns

Returns company and primary_contact in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
404
The requested record was not found.
500
The profile could not be loaded.

Update the company

View as Markdown
PATCH/api/v1/company-profile/company

Updates the supplied company settings and preserves omitted settings.

Permissions

Send your API key in X-API-Key. Required permissions are Settings → Write.

Body parameters

namestring
Company name, up to 200 characters.
email_from_namestring
Display name shown on outgoing emails.
company_addressstring
Street address.
company_citystring
City.
company_provincestring
Province or state.
company_zipstring
Postal code.
company_vatstring
VAT registration number.
company_tax_idstring
Tax identification number.
company_emailstring
Company contact email.
company_pecstring
Certified email address.
company_sdistring
Electronic invoicing recipient code.
company_phonestring
Company phone number.
company_websitestring
HTTP or HTTPS website URL.

Returns

Returns the updated company profile and its primary contact in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
400
A field is unknown or invalid.
404
The requested record was not found.
422
One or more fields failed validation.
500
The change could not be saved.

Update the primary contact

View as Markdown
PATCH/api/v1/company-profile/primary-contact

Renames the existing primary contact for the workspace.

Permissions

Send your API key in X-API-Key. Required permissions are Settings → Write.

Body parameters

firstnamestring
Primary contact's given name, up to 15 characters.
surnamestring
Primary contact's surname, up to 15 characters.

Returns

Returns the updated company profile and its primary contact in data.

Errors

401
The API key is missing or invalid.
403
The API key lacks the required permission.
400
A field is unknown or invalid.
404
The requested record was not found.
422
The workspace has no primary contact.
500
The change could not be saved.