List Organizations

Returns a paginated list of organizations for the account. Results are returned 50 per page.

Request

GET /v2/organizations?page=1&sort=name%2Casc HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Type Examples Description
page number page=1
 Page number (1-based)
sort string sort=name,asc
 Sort field and optional direction (e.g., “name”, “customerCount,desc”). Sort field defaults to “lastInteractionAt”, direction defaults to “desc”.

Sorting

Organizations can be sorted by name, customerCount, conversationCount, or lastInteractionAt.

Default: If no sort parameter is provided, organizations are sorted by lastInteractionAt in descending order (most recent interactions first).

Sort direction: Append ,asc or ,desc to the field name to specify the sort direction (e.g., name,asc or customerCount,desc). If the direction is omitted, it defaults to descending.

Examples:

  • No sort parameter - default sort: lastInteractionAt,desc (most recent interactions first)
  • ?sort=name - Sort by name, descending
  • ?sort=name,asc - Sort by name, ascending
  • ?sort=customerCount - Sort by customer count, descending (most customers first)
  • ?sort=conversationCount - Sort by conversation count, descending (most conversations first)
  • ?sort=lastInteractionAt,asc - Sort by last interaction time, ascending (oldest interactions first)

Response

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

{
  "_embedded" : {
    "organizations" : [ {
      "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" : "..."
        }
      }
    }, {
      "id" : 11,
      "name" : "Another Company",
      "website" : "www.another.com",
      "description" : "Another Description",
      "location" : "CA",
      "logoUrl" : "https://another.com/logo.png",
      "note" : "Another Note",
      "domains" : [ "another.com" ],
      "phones" : [ "+1 555 9999" ],
      "brandColor" : "#FF0000",
      "_links" : {
        "self" : {
          "href" : "..."
        }
      }
    }, {
      "id" : 12,
      "name" : "Third Company",
      "website" : "www.third.com",
      "description" : "Third Description",
      "location" : "UK",
      "logoUrl" : "https://third.com/logo.png",
      "note" : "Third Note",
      "domains" : [ "third.com", "third.co.uk" ],
      "phones" : [ "+44 20 1234 5678" ],
      "brandColor" : "#00FF00",
      "_links" : {
        "self" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    },
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.organizations Array Array of Organization objects
↑Back to top