Marketo Engage Rest API (1.0)

Download OpenAPI specification:Download

URL: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home License: API License Agreement Terms of Service

Marketo Engage Rest API

User Management

Marketo Engage provides a set of User Management endpoints allow you to perform CRUD operations on user records in Marketo.

Get Users

Retrieve a list of all user records. Required Permissions: Access User Management Api and Access Users

Request
query Parameters
pageOffset
integer <int32>
Default: 0

Integer offset for paging. Default is 0

pageSize
integer <int32>
Default: 20

Maximum number of users to return. Max 200, default 20

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/userservice/management/v1/users/allusers.json
Response samples
application/json
[
  • {
    }
]

Invite User

Send an email invitation to new user. Required Permissions: Access User Management Api and Access Users

Request
Request Body schema: application/json
required

inviteUserRequest

apiOnly
boolean

Whether the user is API-Only. Default is false

emailAddress
required
string [ 1 .. 2147483647 ] characters ^("?)(?:[^"])(?:[-\w.!#$%&\'*+\/=?^_`{|}~])*\...

User email address

expiresAt
string

Date and time when user login expires. Must be valid ISO-8601 string. See Datetime field type description.

firstName
required
string

User first name

lastName
required
string

User last name

userid
string

User id in the form of an email address. If not specified, the emailAddress value is used

reason
string

Reason for user invitation

required
Array of objects (UserRoleWorkspaceId)
Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/userservice/management/v1/users/invite.json
Request samples
application/json
{
  • "apiOnly": true,
  • "emailAddress": "string",
  • "expiresAt": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "userid": "string",
  • "reason": "string",
  • "userRoleWorkspaces": [
    ]
}
Response samples
application/json
"string"

Get Roles

Retrieve list of all role records. Required Permissions: Access User Management Api and Access Users

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/userservice/management/v1/users/roles.json
Response samples
application/json
[
  • {
    }
]

Get Workspaces

Retrieve list of workspace records. Required Permissions: Access User Management Api and Access Users

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/userservice/management/v1/users/workspaces.json
Response samples
application/json
[
  • {
    }
]

Delete User

Delete user. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/userservice/management/v1/users/{userid}/delete.json

Delete Invited User

Delete pending user. A pending user is a user that has not yet accepted invitation. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/userservice/management/v1/users/{userid}/invite/delete.json

Update User Attributes

Update one or more user attributes. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Request Body schema: application/json
required

updateUserAttributesRequest

apiOnly
boolean

Whether the user is API-Only. Default is false

emailAddress
string [ 1 .. 2147483647 ] characters ^("?)(?:[^"])(?:[-\w.!#$%&\'*+\/=?^_`{|}~])*\...

User email address

expiresAt
string

Date and time when user login expires. Example: yyyy-MM-dd'T'HH:mm:ss.SSS't'Z

firstName
string

User first name

lastName
string

User last name

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/userservice/management/v1/users/{userid}/update.json
Request samples
application/json
{
  • "apiOnly": true,
  • "emailAddress": "string",
  • "expiresAt": "yyyyMMdd'T'HH:mm:ss'.'S't'Z",
  • "firstName": "string",
  • "lastName": "string"
}
Response samples
application/json
{
  • "errors": [
    ],
  • "apiOnly": true,
  • "emailAddress": "string",
  • "expiresAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z",
  • "lastLoginAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z",
  • "failedDeviceCode": 0,
  • "failedLogins": 0,
  • "firstName": "string",
  • "id": 0,
  • "isLocked": true,
  • "lastName": "string",
  • "lockedReason": "string",
  • "optedIn": true,
  • "userRoleWorkspaces": [
    ],
  • "userid": "string"
}

Get Roles and Workspaces by Id

Get roles and workspaces for a given user. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/userservice/management/v1/users/{userid}/roles.json
Response samples
application/json
[
  • {
    }
]

Add Roles

Add roles to a user. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Request Body schema: application/json
required

addRolesRequest

required
Array of objects (UserRoleWorkspaceId)

List of roles to add

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/userservice/management/v1/users/{userid}/roles/create.json
Request samples
application/json
{
  • "input": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Delete Roles

Delete roles from user. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Request Body schema: application/json
required

deleteRolesRequest

required
Array of objects (UserRoleWorkspaceId)

List of roles to delete

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/userservice/management/v1/users/{userid}/roles/delete.json
Request samples
application/json
{
  • "input": [
    ]
}
Response samples
application/json
[
  • {
    }
]

Get User by Id

Retrieve a single user record through its Id. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/userservice/management/v1/users/{userid}/user.json
Response samples
application/json
{
  • "errors": [
    ],
  • "apiOnly": true,
  • "emailAddress": "string",
  • "expiresAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z",
  • "lastLoginAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z",
  • "failedDeviceCode": 0,
  • "failedLogins": 0,
  • "firstName": "string",
  • "id": 0,
  • "isLocked": true,
  • "lastName": "string",
  • "lockedReason": "string",
  • "optedIn": true,
  • "userRoleWorkspaces": [
    ],
  • "userid": "string"
}

Get Invited User by Id

Retrieve a single pending user record through its Id. A pending user is a user that has not yet accepted invitation. Required Permissions: Access User Management Api and Access Users

Request
path Parameters
userid
required
string

User id in the form of an email address

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/userservice/management/v1/users/{userid}/invite.json
Response samples
application/json
{
  • "errors": [
    ],
  • "id": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddress": "string",
  • "userid": "string",
  • "subscriptionId": "string",
  • "status": "pending",
  • "expiresAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z",
  • "createdAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z",
  • "updatedAt": "yyyy-MM-dd'T'HH:mm:ss.SSS't'Z"
}