Skip to content

The contact's store orders and their consent in each store

GET
/api/v1/workspaces/{workspace}/contacts/{contactId}/stores
curl --request GET \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stores \
--header 'Authorization: Bearer <token>'

Permission: subscribers:view

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

contactId
required

The contact’s id

string format: uuid

The contact’s id

OK

Media typeapplication/json
object
orders
required
Array<object>
object
accepted
required
boolean
credited
string
creditedKind
string
Allowed values: campaign automation ""
currency
required
string
id
required
string
items
required
Array<string>
name
required
string
placedAt
required
string format: date-time
platform
required
string
refunded
required
integer format: int64
store
required
string
storeId
required
string
total
required
integer format: int64
stores
required
Array<object>
object
consentAt
string format: date-time
currency
required
string
listName
string
marketing
required
string
Allowed values: subscribed not_subscribed unsubscribed pending none
name
required
string
onList
required
boolean
orders
required
integer format: int64
platform
required
string
spent
required
integer format: int64
storeId
required
string

Example

{
"orders": [
{
"creditedKind": "campaign"
}
],
"stores": [
{
"marketing": "subscribed"
}
]
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}