HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Retrieves the details of the campaign instance from the specific tenant.

get
https://{tenanturl}/v2.0/instances/

The API is used to retrieve the campaign instance details from the specific tenant.
The owners of the application can retrieve the campaign instances details that are created by them or includes at least one application owned by them.
Entitlements required: manageAccessCertification [Manage Access Certification].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

Campaign Instance ID

Query Params
boolean

Consider the calling user as a supervisor of the campaign when set to true.

string
Defaults to assigned

Filter campaign instances based on the source: 'all', 'assigned', 'delegated'.

Headers
boolean
required

If the value is set to true, the API call is treated as an admin API call.

Responses
200

The request was successful.

400

Your request can't be processed. The error code and description are available in the response payload.

401

Your request can't be processed. The error code and description are available in the response payload.

403

Your request can't be processed. The error code and description are available in the response payload.

500

Your request cannot be processed because an internal server error occurred.

Updated about 1 month ago

Language
URL
LoadingLoading


Updated about 1 month ago