Back to MarketoGet SalesPersons
Retrieves salesperson records from the destination instance based on the submitted filter. Required Permissions: Read-Only Sales Person, Read-Write Sales Person
Input
type: object
properties:
parameters:
type: object
properties:
filterType:
type: string
description: >-
The sales person field to filter on. Searchable fields can be
retrieved with the Describe Sales Person call.
filterValues:
type: array
items:
type: string
description: Comma seperated list of search values.
fields:
type: array
items:
type: string
description: Comma-separated list of fields to include in the response
batchSize:
type: integer
format: int32
description: The batch size to return. The max and default value is 300.
nextPageToken:
type: string
description: >-
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.
required:
- filterType
- filterValues
title: Parameters
Output
required:
- errors
- requestId
- result
- success
- warnings
type: object
properties:
errors:
type: array
description: Array of errors that occurred if the request was unsuccessful
items:
required:
- code
- message
type: object
properties:
code:
type: string
description: >-
Error code of the error. See full list of error codes <a
href="https://developers.marketo.com/rest-api/error-codes/">here</a>
message:
type: string
description: Message describing the cause of the error
moreResult:
type: boolean
description: Boolean indicating if there are more results in subsequent pages
example: false
nextPageToken:
type: string
description: Paging token given if the result set exceeded the allowed batch size
requestId:
type: string
description: Id of the request made
result:
type: array
description: Array of results for individual records in the operation, may be empty
items:
type: object
properties:
id:
type: integer
description: Unique integer id of the salesperson record
format: int64
reasons:
type: array
description: >-
List of reasons why an operation did not succeed. Reasons are only
present in API responses and should not be submitted
items:
required:
- code
- message
type: object
properties:
code:
type: string
description: Integer code of the reason
message:
type: string
description: Message describing the reason for the status of the operation
seq:
type: integer
description: >-
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.
format: int32
status:
type: string
description: Status of the operation performed on the record
enum:
- created
- updated
- deleted
- skipped
- added
- removed
success:
type: boolean
description: Whether the request succeeded
example: false
warnings:
type: array
description: Array of warnings given for the operation
items:
required:
- code
- message
type: object
properties:
code:
type: integer
description: Integer code of the warning
format: int32
message:
type: string
description: Message describing the warning