Profile

Get business profile

get

/organizations/{organizationId}/profile

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/profile' \
  --header 'Authorization: Bearer jwt'

200

404

200

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

OK

Update business profile

patch

/organizations/{organizationId}/profile

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

Body

namestring · max: 256

The name under which this business is commonly referred to.

legalNamestring · max: 256

The name under which this business is registered.

domainstring · max: 253

The primary domain for this business.

descriptionstring · max: 256

foundedYearinteger · int32

locationstring · max: 1000

The address where this business is located.

logoUrlstring

Pattern: ^|https://

phonestring · max: 24

vatNumberstring

invoicingContactEmailstring

typestring · enum · default: unknown

The business type.

Options: unknown, public, private, personal, education, government, nonprofit

domainAliasesstring · max: 253[]

The other domains that are associated with this business.

identifiersBusinessIdentifiers

tagsstring · max: 256[]

categoryBusinessCategory

geoBusinessLocation

Detailed location of company headquarters.

facebookFacebookProfile

linkedinLinkedInProfile

twitterTwitterProfile

crunchbaseCrunchbaseProfile

significantContactsSignificantContacts

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/profile' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"type":"unknown","domainAliases":[null],"identifiers":{"ANY_ADDITIONAL_PROPERTY":"text"},"tags":[null],"category":{"sector":"text","industryGroup":"text","industry":"text","subIndustry":"text","sicCode":"text","naicsCode":"text"},"geo":{"streetNumber":"text","streetName":"text","subPremise":"text","city":"text","postalCode":"text","state":"text","stateCode":"text","country":"text","countryCode":"text","lat":1,"lng":1},"facebook":{"handle":"text"},"linkedin":{"handle":"text"},"twitter":{"handle":"text","id":"text","bio":"text","followers":1,"following":1,"location":"text","site":"text","avatar":"text"},"crunchbase":{"handle":"text"},"significantContacts":{"predefinedContactCategories":["text"],"contacts":[{"name":"text","email":"text","phone":"text","contactCategories":["text"]}]}}'

200

404

422

200

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

OK