Get Organization by ID

Returns a single organization by ID.

Request

GET /v2/organizations/10 HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/organizations/{organizationId}

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",
  "_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
↑Back to top