Profile

Get business profile

get

Authorizations

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",
  "type": "unknown",
  "domain": "text",
  "domainAliases": [
    "text"
  ],
  "category": {
    "sector": "text",
    "industryGroup": "text",
    "industry": "text",
    "subIndustry": "text",
    "sicCode": "text",
    "naicsCode": "text"
  },
  "identifiers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "tags": [
    "text"
  ],
  "description": "text",
  "foundedYear": 1,
  "location": "text",
  "geo": {
    "streetNumber": "text",
    "streetName": "text",
    "subPremise": "text",
    "city": "text",
    "postalCode": "text",
    "state": "text",
    "stateCode": "text",
    "country": "text",
    "countryCode": "text",
    "lat": 1,
    "lng": 1
  },
  "logoUrl": "text",
  "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"
  },
  "phone": "text",
  "vatNumber": "text",
  "invoicingContactEmail": "text",
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}

OK

Update business profile

patch

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

namestring · max: 256optional

The name under which this business is commonly referred to.

legalNamestring · max: 256optional

The name under which this business is registered.

typestring · enum · default: "unknown"optional

The business type.

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

domainstring · max: 253optional

The primary domain for this business.

domainAliasesstring[] · max: 20optional

The other domains that are associated with this business.

categoryobjectoptional

identifiersobjectoptional

tagsstring[] · max: 20optional

descriptionstring · max: 256optional

foundedYearinteger · int32optional

locationstring · max: 1000optional

The address where this business is located.

geoobjectoptional

Detailed location of company headquarters.

logoUrlstringoptional

Pattern: ^|https://

facebookobjectoptional

linkedinobjectoptional

twitterobjectoptional

crunchbaseobjectoptional

phonestring · max: 24optional

vatNumberstringoptional

invoicingContactEmailstringoptional

significantContactsobjectoptional

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 '{
    "name": "text",
    "legalName": "text",
    "type": "unknown",
    "domain": "text",
    "domainAliases": [
      "text"
    ],
    "category": {
      "sector": "text",
      "industryGroup": "text",
      "industry": "text",
      "subIndustry": "text",
      "sicCode": "text",
      "naicsCode": "text"
    },
    "identifiers": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "tags": [
      "text"
    ],
    "description": "text",
    "foundedYear": 1,
    "location": "text",
    "geo": {
      "streetNumber": "text",
      "streetName": "text",
      "subPremise": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "stateCode": "text",
      "country": "text",
      "countryCode": "text",
      "lat": 1,
      "lng": 1
    },
    "logoUrl": "text",
    "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"
    },
    "phone": "text",
    "vatNumber": "text",
    "invoicingContactEmail": "text",
    "significantContacts": {
      "contacts": [
        {
          "name": "text",
          "email": "text",
          "contactCategories": [
            "text"
          ],
          "phone": "text"
        }
      ],
      "predefinedContactCategories": [
        "text"
      ]
    }
  }'

200

404

422

200

{
  "name": "text",
  "legalName": "text",
  "type": "unknown",
  "domain": "text",
  "domainAliases": [
    "text"
  ],
  "category": {
    "sector": "text",
    "industryGroup": "text",
    "industry": "text",
    "subIndustry": "text",
    "sicCode": "text",
    "naicsCode": "text"
  },
  "identifiers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "tags": [
    "text"
  ],
  "description": "text",
  "foundedYear": 1,
  "location": "text",
  "geo": {
    "streetNumber": "text",
    "streetName": "text",
    "subPremise": "text",
    "city": "text",
    "postalCode": "text",
    "state": "text",
    "stateCode": "text",
    "country": "text",
    "countryCode": "text",
    "lat": 1,
    "lng": 1
  },
  "logoUrl": "text",
  "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"
  },
  "phone": "text",
  "vatNumber": "text",
  "invoicingContactEmail": "text",
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}

OK