Get Named Account Lists

GET /rest/v1/namedAccountLists.json

Retrieves a list of named account list records based on the filter type and values given.

Operation ID: getNamedAccountListsUsingGET
Permissions: Read-Only Named Account List, Read-Write Named Account List
Request format: application/json
Returns: ResponseOfNamedAccountList

Parameters

Query 4

filterType string required

The named account list field to filter on ("dedupeFields" or "idFields").

filterValues array of string required

Comma-separated list of values to match against

batchSize integer (int32)

The batch size to return. The max and default value is 300.

nextPageToken string

A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Responses

200 OK ResponseOfNamedAccountList

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

moreResult boolean

Boolean indicating if there are more results in subsequent pages

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of NamedAccountList required

Array of results for individual records in the operation, may be empty

Model NamedAccountList

createdAt string

Datetime when the named account list was created

marketoGUID string required

Unique GUID of the custom object records

name string

Name of named account list

reasons array of Reason

List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted

Model Reason

code string required

Integer code of the reason

message string required

Message describing the reason for the status of the operation

seq integer (int32) required

Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.

status string

Values created updated deleted skipped added removed

type string

Type of named account list ("default" if created by user or API, "external" if managed by CRM-View)

updateable boolean

Whether the list is updateable (true if created by user or API, false if managed by CRM-View)

updatedAt string

Datetime when the named account list was most recently updated

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "createdAt": "string",
      "marketoGUID": "123",
      "name": "Example name",
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "seq": 123,
      "status": "created",
      "type": "string",
      "updateable": false,
      "updatedAt": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.