Skip to main content
GET
/
v1
/
surface
/
content
Get surface content
curl --request GET \
  --url https://content.api.aampe.com/v1/surface/content \
  --header 'X-API-Key: <api-key>'
[
  {
    "surface_id": "9815c123-51ce-4ad6-a4c7-2915d5e61638",
    "assignment_id": "c52d6c8c-14f4-4229-9a63-3c799917ceac",
    "n_alternates": 1,
    "control": {
      "min_gap_days": 1
    },
    "alternates": [
      {
        "alternate_assignment_id": "207a0489-03e5-4a2b-b130-f7a723d19170"
      }
    ]
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
contact_id
string
required

The ID of the user for which you want to retrieve content.

​
surface_id
string<uuid>[]
required

The UUID v4 IDs of the surfaces for which you want to retrieve content.

Response

Successful Response

​
surface_id
string<uuid>
required

UUID v4 id for the surface

Example:

"9815c123-51ce-4ad6-a4c7-2915d5e61638"

​
assignment_id
string<uuid>
required

UUID v4 id for the content assignment

Example:

"c52d6c8c-14f4-4229-9a63-3c799917ceac"

​
n_alternates
integer
required

Total number of alternates

Example:

1

​
control
SurfaceControl · object
required
​
alternates
SurfaceAlternate · object[]
required