Retrieve the full configuration details of a Exchange ActiveSync payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To get Exchange Active Sync policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/exchangeactivesyncpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

account_namestring

Account Name. Default: Exchange ActiveSync

active_sync_hoststring

Active Sync Host

allow_moveboolean

Allow Move. Default: true

prevent_moveboolean

Prevent Move. Default: false

disable_mail_recents_syncingboolean

Disable Mail Recents Syncing. Default: false

use_only_mail_appboolean

Use Only Mail App. Default: false

use_sslboolean

Use Ssl. Default: true

use_mime_encryptboolean

Use Mime Encrypt. Default: false

signing_cert_idlong

Signing identity certificate ID obtained from the Certificates API.

encryption_cert_idlong

Encryption identity certificate ID obtained from the Certificates API.

domainstring

Domain. Default: %domainname%

user_namestring

User Name. Default: %upn%

email_addressstring

Email Address. Default: %email%

passwordstring

Password (sensitive - write-only)

password_idlong

Password Id

past_days_mail_to_syncinteger

Past Days Mail To Sync. Default: 0

identity_cert_idlong

Identity certificate ID obtained from the Certificates API. Must be an identity certificate (is_identity = true)

cert_compatible_ios4boolean

Cert Compatible Ios4. Default: false

oauthboolean

Oauth. Default: false

sync_calenderinteger

Calendar sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict

sync_contactsinteger

Contacts sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict

sync_notesinteger

Notes sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict

sync_mailinteger

Mail sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict

sync_reminderinteger

Reminders sync setting. Allowed values: 0=Default, 1=Restrict modification, 2=Disable sync, 3=Disable and restrict, 4=Enable sync, 5=Enable and restrict

oauth_signin_urlstring

Oauth Signin Url

oauth_token_request_urlstring

Oauth Token Request Url

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Exchange ActiveSync payload item

Copied!
  {
    "prevent_move": false,
    "use_mime_encrypt": false,
    "payload_id": 9007199254741000,
    "disable_mail_recents_syncing": false,
    "allow_move": true,
    "use_ssl": true,
    "user_name": "user@zylker.com",
    "past_days_mail_to_sync": 7,
    "encryption_cert_id": -1,
    "email_address": "user@zylker.com",
    "signing_cert_id": -1,
    "account_name": "Exchange ActiveSync",
    "active_sync_host": "https://zylker.com",
    "use_only_mail_app": false
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.