Get Organization Customers

Returns customers associated with an organization with the given ID.

Request

GET /v2/organizations/10/customers?page=1 HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/organizations/{organizationId}/customers

URL Parameters

Parameter Type Examples Description
page number page=1
Page number (1-based)

Response

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

{
  "_embedded" : {
    "customers" : [ {
      "id" : 100,
      "firstName" : "John",
      "lastName" : "Doe",
      "gender" : "Male",
      "jobTitle" : "Software Engineer",
      "location" : "San Francisco, CA",
      "organization" : "Test Company",
      "photoType" : "gravatar",
      "photoUrl" : "http://example.com/john.jpg",
      "age" : "25-30",
      "createdAt" : "2023-01-15T10:30:00Z",
      "updatedAt" : "2023-06-20T14:45:00Z",
      "background" : "Experienced developer",
      "_embedded" : {
        "emails" : [ ],
        "phones" : [ ],
        "chats" : [ ],
        "social_profiles" : [ ],
        "websites" : [ ],
        "properties" : [ ]
      },
      "_links" : {
        "address" : {
          "href" : "..."
        },
        "chats" : {
          "href" : "..."
        },
        "emails" : {
          "href" : "..."
        },
        "phones" : {
          "href" : "..."
        },
        "social-profiles" : {
          "href" : "..."
        },
        "websites" : {
          "href" : "..."
        },
        "self" : {
          "href" : "..."
        }
      }
    }, {
      "id" : 101,
      "firstName" : "Jane",
      "lastName" : "Smith",
      "gender" : "Female",
      "jobTitle" : "Product Manager",
      "location" : "New York, NY",
      "organization" : "Test Company",
      "photoType" : "twitter",
      "photoUrl" : "http://example.com/jane.jpg",
      "age" : "30-35",
      "createdAt" : "2023-02-10T09:15:00Z",
      "updatedAt" : "2023-06-21T16:20:00Z",
      "background" : "Product strategy expert",
      "_embedded" : {
        "emails" : [ ],
        "phones" : [ ],
        "chats" : [ ],
        "social_profiles" : [ ],
        "websites" : [ ],
        "properties" : [ ]
      },
      "_links" : {
        "address" : {
          "href" : "..."
        },
        "chats" : {
          "href" : "..."
        },
        "emails" : {
          "href" : "..."
        },
        "phones" : {
          "href" : "..."
        },
        "social-profiles" : {
          "href" : "..."
        },
        "websites" : {
          "href" : "..."
        },
        "self" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    },
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.customers Array Array of Customer objects