Back to MarketoDescribe SalesPersons
Returns metadata about salespersons and the fields available for interaction via the API. Required Permissions: Read-Only Sales Person, Read-Write Sales Person
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:
required:
- apiName
- createdAt
- dedupeFields
- description
- displayName
- fields
- idField
- pluralName
- relationships
- searchableFields
- updatedAt
- version
type: object
properties:
createdAt:
type: string
description: Datetime when the object type was created
format: date-time
dedupeFields:
type: array
description: >-
List of dedupe fields. Arrays with multiple members are compound
keys
items:
type: string
description:
type: string
description: Description of the object type
displayName:
type: string
description: UI display-name of the object type
pluralName:
type: string
description: UI plural-name of the custom object type
fields:
type: array
description: List of fields available on the object type
items:
type: object
properties:
dataType:
type: string
description: Datatype of the field
displayName:
type: string
description: UI display-name of the field
length:
type: integer
description: >-
Max length of the field. Only applicable to text, string, and
text area.
format: int32
name:
type: string
description: Name of the field
updateable:
type: boolean
description: Whether the field is updateable
example: false
crmManaged:
type: boolean
description: Whether the field is managed by CRM (native sync)
example: false
idField:
type: string
description: Primary id key of the object type
apiName:
type: string
description: Name of the object type
relationships:
type: array
description: List of relationships which the object has
items:
required:
- field
- relatedTo
- type
type: object
properties:
field:
type: string
description: API Name of link field
relatedTo:
required:
- field
- name
type: object
properties:
field:
type: string
description: Name of link field (within link object)
name:
type: string
description: Name of the link object
type:
type: string
description: Type of the relationship field
searchableFields:
type: array
description: List of fields valid for use as a filter type in a query
items:
type: array
items:
type: string
updatedAt:
type: string
description: Datetime when the object type was most recently updated
format: date-time
state:
type: string
description: Approval state of object type
enum:
- draft
- approved
- approvedWithDraft
version:
type: string
description: Version of object type that is returned in response
enum:
- draft
- approved
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