Jump to

• Request
• Response
• Examples

Retrieve a contact filter

get

/api/bulk/2.0/contacts/filters/{id}

Retrieves a contact filter that matches the criteria specified in the URL parameters.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  Number of results returned in the request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ContactFilterIndividualResponse

Type: object

Title: ContactFilterIndividualResponse

Indicates if there are more results.

Show Source

• count: integer
  Title: count

  The number of items returned. In items: the number of records operated on for that message.
• createdAt: string(date-time)
  Title: createdAt

  The date and time the contact filter was created, expressed using the ISO-8601 standard. This is a read-only property.
• createdBy: string
  Title: createdBy

  The login id of the user who created the contact filter field. This is a read-only property.
• executedAt: string(date-time)
  Title: executedAt

  The time and date the contact filter was last used.
• name: string
  Title: name

  The name of the contact definition.
• statement: string
  Title: statement

  The markup language statement used to reference the field in an import or export mapping.
• updatedAt: string(date-time)
  Title: updatedAt

  The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
• updatedBy: string
  Title: updatedBy

  The login id of the user that last updated the entity. This is a read-only property.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"ContactFilterIndividualResponse",
    "description":"Indicates if there are more results.",
    "properties":{
        "count":{
            "title":"count",
            "description":"The number of items returned.\r\n\r\nIn items: the number of records operated on for that message.",
            "type":"integer"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the contact filter was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the contact filter field. This is a read-only property.",
            "type":"string"
        },
        "executedAt":{
            "format":"date-time",
            "title":"executedAt",
            "description":"The time and date the contact filter was last used.",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The name of the contact definition.",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"The markup language statement used to reference the field in an import or export mapping.",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "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 the contact filter with id #100057:

GET /contacts/filters/100057
			

Response:

{
    "name":"Filter Criteria 1",
    "count":541,
    "executedAt":"2015-06-22T14:19:38.6970000Z",
    "statement":"{{ContactFilter[100057]}}",
    "uri":"/contacts/filters/100057",
    "createdBy":"API.User",
    "createdAt":"2015-06-22T14:19:29.1070000Z",
    "updatedBy":"API.User",
    "updatedAt":"2015-06-22T14:19:41.6000000Z"
}
			

Back to Top