We’ve made the difficult decision to sunset Hire by Google on September 1, 2020. Learn more.

Method: tenants.customFieldSpecs.list

List the custom field spec in Hire.

HTTP request

GET https://hire.googleapis.com/v1beta1/{parent=tenants/*}/customFieldSpecs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The name of the tenant to list custom field spec on. We accept "my_tenant" as a valid tenant if the account only has access to one tenant. A valid parent would be "tenants/my_tenant".

Query parameters

Parameters
pageSize

number

The maximum number of items to return. Acceptable values are 1 to 100. Defaults to 100.

pageToken

string

Optional pagination token returned in a previous request.

filter

string

Optional filter on custom field spec. Attempts to query with an unrecognized filter dimension will result in an INVALID_ARGUMENT error. Supported querying are as follows:

  • objectTypes[]=[CustomFieldSpec.ObjectType]

Sample Query:

  • objectTypes[]=JOB

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response containing a list of custom field specs for a specific request.

JSON representation
{
  "customFieldSpecs": [
    {
      object (CustomFieldSpec)
    }
  ],
  "nextPageToken": string
}
Fields
customFieldSpecs[]

object (CustomFieldSpec)

The list of custom field specs matching the provided filter.

nextPageToken

string

Token used to access the next page of this result. Omitted if no further results are available. Token can be used up to 6 hours after the original ListCustomFieldSpecsRequest. Note that in some rare cases token might become invalid before.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/hire.customfieldspec.readonly

For more information, see the OAuth 2.0 Overview.