Get Organization by ID

Returns a single organization by ID.

Request

GET /v2/organizations/10?includeCounts=true&includeProperties=true HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/organizations/{organizationId}

URL Parameters

Parameter Type Examples Description
includeCounts boolean includeCounts=true
 Whether to include customer and conversation counts
includeProperties boolean includeProperties=true
 Whether to include organization property values

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "id" : 10,
  "name" : "Test Company",
  "website" : "www.example.com",
  "description" : "Test Description",
  "location" : "US",
  "logoUrl" : "https://example.com/logo.png",
  "note" : "Test Note",
  "domains" : [ "domain.com", "domain.org" ],
  "phones" : [ "1-23-456", "+1 234 5678" ],
  "brandColor" : "#000FFF",
  "customerCount" : 42,
  "conversationCount" : 17,
  "properties" : [ {
    "definitionId" : 1001,
    "slug" : "annual-revenue",
    "name" : "Annual Revenue",
    "type" : "number",
    "value" : "5000000"
  }, {
    "definitionId" : 1002,
    "slug" : "industry",
    "name" : "Industry",
    "type" : "dropdown",
    "value" : "Software",
    "options" : [ {
      "label" : "Software"
    }, {
      "label" : "Healthcare"
    }, {
      "label" : "Finance"
    } ]
  }, {
    "definitionId" : 1003,
    "slug" : "founded-date",
    "name" : "Founded Date",
    "type" : "date",
    "value" : "2020-01-15"
  } ],
  "_links" : {
    "self" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
id Number Organization’s unique ID
name String Organization’s name
website String Organization’s website
description String Organization’s description
location String Organization’s two letter country code
logoUrl String Organization’s logo URL
note String Organization’s custom note
domains Array Organization’s domains. Used to match customers to this organization by their emails
phones Array Organization’s phone numbers. Might contain special characters.
brandColor String Organization’s brand color in a valid hex format
customerCount Number Number of customers associated with the organization. Only included when includeCounts=true
conversationCount Number Number of conversations associated with the organization. Only included when includeCounts=true
properties Array Array of organization property values. Only included when includeProperties=true
properties[].definitionId Number Unique identifier of the property definition
properties[].slug String Unique slug identifying the property
properties[].name String Display name of the property
properties[].type String Type of the property (text, number, url, date, dropdown)
properties[].value String Current value of the property
properties[].options Array Available options for dropdown properties. Only populated for dropdown type properties.
properties[].options[].label String Display label for the dropdown option
↑Back to top