Skip to content
Baack

Company

Representation of a company object which may have a parent company (in structured companies), an owner, if this company represents some CRM company owned by a customer company and an organisation for which this company and associated accounts are provisioned.

Browse the docs

Endpoints

  • GET/n/v1/company/{urn}

    Company endpoint with support for companies used both internally for account structure and CRM company representations. Baack supports Company structures under an Organisation. Each company includes it's own usage / billing context. Typically an organisation with an account will include a Company for test / development purposes as well as one for production. Baack keeps company related concepts separate and each company has it's own encryption setup for data encryption at rest for Customer Information.

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns CompanyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/company/{urn}

Fields

Company fields
FieldTypeDescription
urnstring (uuid)
parentCompanyCompany
ownerCompany
namestring
organisationOrganisation
urlstring (uri)
entityEntity

Ignored on update.

Used by: API Client, Client Context, Company Page, Entity, Entity List, Group, Identity, Message Thread, Payment Invoice, Permission, Project, Recipient, Remitter, Role, Search, Task, Webhook Trigger, Workflow