Profile

Get business profile

get

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Responses

200

OK

application/json

404

Resource not found

application/json

get

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/profile HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "name": "text",
  "legalName": "text",
  "type": "unknown",
  "domain": "example.com",
  "domainAliases": [
    "example.com"
  ],
  "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"
    ]
  }
}

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 · enumOptional

The business type.

Default: unknownPossible values:

domainstring · max: 253Optional

Domain name.

Example: example.comPattern: ^$|^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)+([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$

domainAliasesstring[] · max: 20Optional

The other domains that are associated with this business.

Example: example.com

tagsstring[] · max: 20Optional

descriptionstring · max: 256Optional

foundedYearinteger · int32Optional

locationstring · max: 1000Optional

The address where this business is located.

logoUrlstringOptionalPattern: ^|https://

phonestring · max: 24Optional

vatNumberstringOptional

invoicingContactEmailstringOptional

Responses

200

OK

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId}/profile HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 996

{
  "name": "text",
  "legalName": "text",
  "type": "unknown",
  "domain": "example.com",
  "domainAliases": [
    "example.com"
  ],
  "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"
    ]
  }
}

{
  "name": "text",
  "legalName": "text",
  "type": "unknown",
  "domain": "example.com",
  "domainAliases": [
    "example.com"
  ],
  "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"
    ]
  }
}