Jump to

• Request
• Response
• Examples

Retrieve a list of contact field definitions

get

/api/bulk/2.0/contacts/fields

Retrieves a list of contact field definitions.

Request

Supported Media Types

• application/json
• text/csv

Query Parameters

• limit: integer
• links: string
• offset: integer
• orderBy: string
• q: string
• totalResults: boolean

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ContactFieldSearchResponse

Type: object

Title: ContactFieldSearchResponse

Show Source

• count(optional): integer
  Title: count
• hasMore(optional): boolean
  Title: hasMore
• items(optional): array items
  Title: items
• limit(optional): integer
  Title: limit
• offset(optional): integer
  Title: offset
• totalResults(optional): integer(int64)
  Title: totalResults

{
    "title":"ContactFieldSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContactField"
            }
        },
        "limit":{
            "title":"limit",
            "description":"",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

• Array of: object ContactField
  Title: ContactField

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContactField"
    }
}

Nested Schema : ContactField

Type: object

Title: ContactField

Show Source

• createdAt(optional): string(date-time)
  Title: createdAt
• createdBy(optional): string
  Title: createdBy
• dataType(optional): string
  Title: DataType

  Default Value: number

  Allowed Values: [ "number", "string", "boolean", "date", "emailAddress" ]
• defaultValue(optional): string
  Title: defaultValue
• hasNotNullConstraint(optional): boolean
  Title: hasNotNullConstraint
• hasReadOnlyConstraint(optional): boolean
  Title: hasReadOnlyConstraint
• hasUniquenessConstraint(optional): boolean
  Title: hasUniquenessConstraint
• internalName(optional): string
  Title: internalName
• name(optional): string
  Title: name
• statement(optional): string
  Title: statement
• updatedAt(optional): string(date-time)
  Title: updatedAt
• updatedBy(optional): string
  Title: updatedBy
• uri(optional): string
  Title: uri

{
    "title":"ContactField",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataType":{
            "$ref":"#/definitions/DataType"
        },
        "defaultValue":{
            "title":"defaultValue",
            "description":"",
            "type":"string"
        },
        "hasNotNullConstraint":{
            "title":"hasNotNullConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasReadOnlyConstraint":{
            "title":"hasReadOnlyConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasUniquenessConstraint":{
            "title":"hasUniquenessConstraint",
            "description":"",
            "type":"boolean"
        },
        "internalName":{
            "title":"internalName",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Retrieve a list of the first 2 contact field parameters:

GET /contacts/fields?limit=2
			

Response:

{
    "items":[
        {
            "name":"Email Address",
            "internalName":"C_EmailAddress",
            "dataType":"emailAddress",
            "hasReadOnlyConstraint":false,
            "hasNotNullConstraint":false,
            "hasUniquenessConstraint":true,
            "statement":"{{Contact.Field(C_EmailAddress)}}",
            "uri":"/contacts/fields/100001",
            "createdAt":"1900-01-01T05:00:00.0000000Z",
            "updatedAt":"1900-01-01T05:00:00.0000000Z"
        },
        {
            "name":"First Name",
            "internalName":"C_FirstName",
            "dataType":"string",
            "hasReadOnlyConstraint":false,
            "hasNotNullConstraint":false,
            "hasUniquenessConstraint":false,
            "statement":"{{Contact.Field(C_FirstName)}}",
            "uri":"/contacts/fields/100002",
            "createdAt":"1900-01-01T05:00:00.0000000Z",
            "updatedBy":"MgrPlatformTeamPod1",
            "updatedAt":"2014-06-16T14:43:50.8100000Z"
        }
    ],
    "totalResults":62,
    "limit":2,
    "offset":0,
    "count":2,
    "hasMore":true
}
			

Back to Top