Profile

Get business profile

GET/organizations/{organizationId}/profile

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Response

200404

OK

Body

application/json

namestring

The name under which this business is commonly referred to.

legalNamestring

The name under which this business is registered.

typeenum

The business type.

unknownpublicprivatepersonaleducationgovernmentnonprofit

domainstring

The primary domain for this business.

domainAliasesarray of string

The other domains that are associated with this business.

categoryBusinessCategory

identifiersBusinessIdentifiers

tagsarray of string

descriptionstring

foundedYearinteger (int32)

locationstring

The address where this business is located.

geoBusinessLocation

Detailed location of company headquarters.

logoUrlstring

Pattern: ^|https://

facebookFacebookProfile

linkedinLinkedInProfile

twitterTwitterProfile

crunchbaseCrunchbaseProfile

phonestring

vatNumberstring

invoicingContactEmailstring

significantContactsSignificantContacts

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/profile', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "name": "text",
  "legalName": "text",
  "type": "unknown",
  "domain": "text",
  "domainAliases": [
    "text"
  ],
  "category": {
    "sector": "text",
    "industryGroup": "text",
    "industry": "text",
    "subIndustry": "text",
    "sicCode": "text",
    "naicsCode": "text"
  },
  "tags": [
    "text"
  ],
  "description": "text",
  "location": "text",
  "geo": {
    "streetNumber": "text",
    "streetName": "text",
    "subPremise": "text",
    "city": "text",
    "postalCode": "text",
    "state": "text",
    "stateCode": "text",
    "country": "text",
    "countryCode": "text",
    "lat": 0,
    "lng": 0
  },
  "logoUrl": "text",
  "facebook": {
    "handle": "text"
  },
  "linkedin": {
    "handle": "text"
  },
  "twitter": {
    "handle": "text",
    "id": "text",
    "bio": "text",
    "followers": 0,
    "following": 0,
    "location": "text",
    "site": "text",
    "avatar": "text"
  },
  "crunchbase": {
    "handle": "text"
  },
  "phone": "text",
  "vatNumber": "text",
  "invoicingContactEmail": "text",
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}

Update business profile

PATCH/organizations/{organizationId}/profile

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

namestring

The name under which this business is commonly referred to.

legalNamestring

The name under which this business is registered.

typeenum

The business type.

unknownpublicprivatepersonaleducationgovernmentnonprofit

domainstring

The primary domain for this business.

domainAliasesarray of string

The other domains that are associated with this business.

categoryBusinessCategory

identifiersBusinessIdentifiers

tagsarray of string

descriptionstring

foundedYearinteger (int32)

locationstring

The address where this business is located.

geoBusinessLocation

Detailed location of company headquarters.

logoUrlstring

Pattern: ^|https://

facebookFacebookProfile

linkedinLinkedInProfile

twitterTwitterProfile

crunchbaseCrunchbaseProfile

phonestring

vatNumberstring

invoicingContactEmailstring

significantContactsSignificantContacts

Response

200404422

OK

Body

application/json

namestring

The name under which this business is commonly referred to.

legalNamestring

The name under which this business is registered.

typeenum

The business type.

unknownpublicprivatepersonaleducationgovernmentnonprofit

domainstring

The primary domain for this business.

domainAliasesarray of string

The other domains that are associated with this business.

categoryBusinessCategory

identifiersBusinessIdentifiers

tagsarray of string

descriptionstring

foundedYearinteger (int32)

locationstring

The address where this business is located.

geoBusinessLocation

Detailed location of company headquarters.

logoUrlstring

Pattern: ^|https://

facebookFacebookProfile

linkedinLinkedInProfile

twitterTwitterProfile

crunchbaseCrunchbaseProfile

phonestring

vatNumberstring

invoicingContactEmailstring

significantContactsSignificantContacts

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/profile', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "name": "text",
  "legalName": "text",
  "type": "unknown",
  "domain": "text",
  "domainAliases": [
    "text"
  ],
  "category": {
    "sector": "text",
    "industryGroup": "text",
    "industry": "text",
    "subIndustry": "text",
    "sicCode": "text",
    "naicsCode": "text"
  },
  "tags": [
    "text"
  ],
  "description": "text",
  "location": "text",
  "geo": {
    "streetNumber": "text",
    "streetName": "text",
    "subPremise": "text",
    "city": "text",
    "postalCode": "text",
    "state": "text",
    "stateCode": "text",
    "country": "text",
    "countryCode": "text",
    "lat": 0,
    "lng": 0
  },
  "logoUrl": "text",
  "facebook": {
    "handle": "text"
  },
  "linkedin": {
    "handle": "text"
  },
  "twitter": {
    "handle": "text",
    "id": "text",
    "bio": "text",
    "followers": 0,
    "following": 0,
    "location": "text",
    "site": "text",
    "avatar": "text"
  },
  "crunchbase": {
    "handle": "text"
  },
  "phone": "text",
  "vatNumber": "text",
  "invoicingContactEmail": "text",
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}