Google Apps Profiles Data API Reference Guide

Warning: The
deprecation period
for the Google Apps Profiles Data API is nearly at an end. On April 20, 2015,
we will discontinue service for this API. This means that service calls to the
API are no longer supported, and features implemented using this API will not
function after April 20, 2015. You must migrate to the
Admin SDK Directory API as soon as possible to avoid
disruptions to your application.

This document provides detailed reference documentation for the raw protocol (XML and HTTP) for the Google Apps Profiles Data API.

This document doesn't contain information about the programming-language client libraries. For client-library reference information, see the links from the programming-language-specific sections of the developer's guide.

Note: This API is only available to Google Apps Premier, Education, and Partner Edition domains, and cannot be used for accessing or editing the Google Apps for free edition or Gmail profiles.

Profiles Data API feed types

The Profiles Data API provides one type of feed: the profiles feed.

The feed is a private read/write feed that can be used to view and manage profiles of users in a Google Apps organization.
Since they are private, a programmer can access them only by using an authenticated request. That is, the request must contain an authentication token for a user in the domain whose profiles you want to retrieve. For more information about authenticating, see the developer's guide.

Profiles feed

The URL for a feed of profiles takes the following form:

https://www.google.com/m8/feeds/profiles/domain/domain/full

For example, the profiles feed for example.com would have the following URI:

In addition to the standard query parameters, the Profiles Data API supports the following parameters:

Name

Description

start-key

Opaque key of the first element to retrieve. Present in the next link of an earlier request, if further pages of response are available.

Profiles elements reference

The Profiles Data API uses the standard Google Data API elements. A profile entry takes the form of an extended Profile kind. The Profile kind appears in XML as an <atom:entry> element that contains various extension elements from the Google Data namespace. For information about the standard Google Data API elements, see the Atom specification and the Kinds document.

The category element indicating that the entry is a profile looks like this:

Extra restrictions on the standard Profile kind's extension elements

The Profiles Data API has the same restrictions on certain elements as the Contacts Data API does. Additionally, a profile entry cannot be marked as deleted (that is, it cannot contain a gd:deleted element). Also note that the Profile kind, unlike the Contact kind, does not support gd:extendedProperty.

Additional extensions of the Profile kind

The Profiles Data API supports all the same extensions as the Contacts Data API, with the exception of groupMembershipInfo. All these extensions belong to the gContact namespace.