Back to MarketoGet Custom Activity Types
Returns metadata regarding custom activities provisioned in the target instance. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata
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:
apiName:
type: string
description: >-
API Name of the type. The API name must be unique and alphanumeric,
containing at least one letter. It is highly recommended to prepend
a unique namespace of up to sixteen characters to the API name.
Required on creation
attributes:
type: array
description: >-
List of attributes for the activity type. May only be added or
update through Create or Update Custom Activity Type Attributes
items:
required:
- apiName
- name
type: object
properties:
apiName:
type: string
description: API Name of the attribute
dataType:
type: string
description: Data type of the attribute
enum:
- string
- boolean
- integer
- float
- link
- email
- currency
- date
- datetime
- phone
- text
description:
type: string
description: Description of the attribute
isPrimary:
type: boolean
description: >-
Whether the attribute is the primary attribute of the activity
type. There may only be one primary attribute at a time
example: false
name:
type: string
description: Human-readable display name of the attribute
createdAt:
type: string
description: Datetime when the activity type was created
description:
type: string
description: Description of the activity type
filterName:
type: string
description: >-
Human-readable name for the associated filter of the activity type.
Required on creation
id:
type: integer
format: int32
name:
type: string
description: Human-readable display name of the type. Required on creation
primaryAttribute:
required:
- apiName
- name
type: object
properties:
apiName:
type: string
description: API Name of the attribute
dataType:
type: string
description: Data type of the attribute
enum:
- string
- boolean
- integer
- float
- link
- email
- currency
- date
- datetime
- phone
- text
description:
type: string
description: Description of the attribute
isPrimary:
type: boolean
description: >-
Whether the attribute is the primary attribute of the activity
type. There may only be one primary attribute at a time
example: false
name:
type: string
description: Human-readable display name of the attribute
status:
type: string
description: State of the activity type
enum:
- draft
- approved
- deleted
- approved with draft
triggerName:
type: string
description: >-
Human-readable name for the associated trigger of the activity
type. Required on creation
updatedAt:
type: string
description: Datetime when the activity type was most recently updated
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