DirectorySiteContacts: list

Requires authorization

Retrieves a list of directory site contacts, possibly filtered. This method supports paging. Try it now.


HTTP request



Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
directorySiteIds long Select only directory site contacts with these directory site IDs. This is a required field.
ids long Select only directory site contacts with these IDs.
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
pageToken string Value of the nextPageToken from the previous result page.
searchString string Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
sortField string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)


This request requires authorization with the following scope (read more about authentication and authorization).


Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "dfareporting#directorySiteContactsListResponse",
  "nextPageToken": string,
  "directorySiteContacts": [
    directorySiteContacts Resource
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
directorySiteContacts[] list Directory site contact collection
nextPageToken string Pagination token to be used for the next list operation.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.