Raisely API

Authentication
Campaigns
Donations
Exercise Logs
Interaction Categories
- get allget
Interactions
Media
- add mediapost
Orders
Posts
Products
- get productget
- all productsget
Profiles
Promo Codes
Segments
- get allget
- all usersget
Subscriptions
Tags
Users
Util
- get allget
Webhooks

get interaction

get https://api.raisely.com/v3/interactions/{uuid}

Retrieve a specific interaction.

For custom components:

RaiselyComponents.api.one('interactions', '{uuid}').get(params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

uuid

string

required

The uuid of the record

Query Params

private

boolean

Returns the full record when authenticated

Headers

Authorization

string

A valid HTTP Bearer token, required to access private records.

Responses

Response body

object

data

object

action

string

public The action the interaction represents

category

object

public

categoryUuid

string

public Unique identifier for the record

context

object

public

Has additional fields

createdAt

string

public Date the record was created

detail

object

required

public Additional details relating to this Raisely interaction

diff

object

public Additional details about the changes applied to an update (updated interaction only)

Has additional fields

externalId

string

public

immutable

object

public

Has additional fields

internalOnly

boolean

public

model

string

public The model represented by this interaction

organisationUuid

string

public Unique identifier for the record

recordType

string

public The type of record represented by this interaction

recordUuid

string

public Unique identifier for the record

tokenUuid

string

public Unique identifier for the record

user

object

public

userUuid

string

public Unique identifier for the record

uuid

string

public Unique identifier for the record

Response body

object

detail

string

Summary of the problem that's suitable to show to a user

type

string

time

string

ISO8601 time of the error

instance

string

The specific occurance of the error. You can pass this value to support to help with tracking down an error

code

string

A code defining the type of error

unauthorized

status

integer

The HTTP status code response

errors

array of objects

One or more objects describing the individual errors encountered

Errors

object

code

string

A code defining the type of error

unauthorized

status

integer

The HTTP status code response

message

string

Description of the error

subcode

string

Optional. Provides further detail on the nature of the error

invalid token upstream

service

string

If the subcode is 'upstream' this identified the upstream authentication provider that failed

facebook google strava

Response body

object

detail

string

Summary of the problem that's suitable to show to a user

type

string

time

string

ISO8601 time of the error

instance

string

The specific occurance of the error. You can pass this value to support to help with tracking down an error

code

string

A code defining the type of error

forbidden

status

integer

The HTTP status code response

errors

array of objects

One or more objects describing the individual errors encountered

Errors

object

code

string

A code defining the type of error

forbidden

status

integer

The HTTP status code response

message

string

Description of the error

subcode

string

Optional. Provides further detail on the nature of the error

Response body

object

detail

string

Summary of the problem that's suitable to show to a user

type

string

time

string

ISO8601 time of the error

instance

string

The specific occurance of the error. You can pass this value to support to help with tracking down an error

code

string

A code defining the type of error

not found

status

integer

The HTTP status code response

errors

array of objects

One or more objects describing the individual errors encountered

Errors

object

code

string

A code defining the type of error

not found

status

integer

The HTTP status code response

message

string

Description of the error

subcode

string

Optional. Provides further detail on the nature of the error

recordId

string

The ID of the record. This may not be a UUID but could be whatever alias was supplied to attempt to find the record

recordType

string

The type of record the error occurred on

Response body

object

detail

string

Summary of the problem that's suitable to show to a user

type

string

time

string

ISO8601 time of the error

instance

string

The specific occurance of the error. You can pass this value to support to help with tracking down an error

code

string

A code defining the type of error

gone

status

integer

The HTTP status code response

errors

array of objects

One or more objects describing the individual errors encountered

Errors

object

code

string

A code defining the type of error

gone

status

integer

The HTTP status code response

message

string

Description of the error

subcode

string

Optional. Provides further detail on the nature of the error

Response body

object

detail

string

Summary of the problem that's suitable to show to a user

type

string

time

string

ISO8601 time of the error

instance

string

The specific occurance of the error. You can pass this value to support to help with tracking down an error

code

string

A code defining the type of error

rate limit exceeded

status

integer

The HTTP status code response

errors

array of objects

One or more objects describing the individual errors encountered

Errors

object

code

string

A code defining the type of error

rate limit exceeded

status

integer

The HTTP status code response

message

string

Description of the error

subcode

string

Optional. Provides further detail on the nature of the error

Response body

object

detail

string

Summary of the problem that's suitable to show to a user

type

string

time

string

ISO8601 time of the error

instance

string

The specific occurance of the error. You can pass this value to support to help with tracking down an error

code

string

A code defining the type of error

internal error

status

integer

The HTTP status code response

errors

array of objects

One or more objects describing the individual errors encountered

Errors

object

code

string

A code defining the type of error

internal error

status

integer

The HTTP status code response

message

string

Description of the error

subcode

string

Optional. Provides further detail on the nature of the error

Updated over 1 year ago

add interaction

update interaction

Did this page help you?

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.raisely.com/v3/interactions/uuid \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

add interaction

update interaction

Did this page help you?

Raisely API
Authentication
registerpost
get allget
check userpost
signuppost
logoutpost
loginpost
Campaigns
all subscriptionsget
all donationsget
all profilesget
restorepost
get campaign profileget
remove campaigndelete
update campaignpatch
get campaignget
add campaignpost
get allget
Donations
all receiptsget
resendpost
matchpost
movepatch
remove donationdelete
update donationpatch
get donationget
add donationpost
get allget
Exercise Logs
remove exercise logdelete
update exercise logpatch
get exercise logget
add exercise logpost
get allget
Interaction Categories
get allget
Interactions
all interactionsget
pinpatch
remove interactiondelete
update interactionpatch
get interactionget
add interactionpost
get allget
Media
add mediapost
Orders
resendpost
get orderget
get allget
Posts
remove postdelete
update postpatch
get postget
add postpost
get allget
Products
all productsget
get productget
Profiles
all donationsget
add memberpost
all membersget
all postsget
leavepatch
joinpatch
profile urlget
remove profiledelete
update profilepatch
get profileget
get allget
Promo Codes
update promo codepatch
get promo codeget
add promo codepost
get allget
Segments
all usersget
get allget
Subscriptions
all donationsget
update subscriptionpatch
get subscriptionget
add subscriptionpost
get allget
Tags
remove recorddelete
add recordpost
all recordsget
get tagget
get allget
Users
all subscriptionsget
all donationsget
all profilesget
update userpatch
get userget
upsertpost
add userpost
get allget
Util
get allget
Webhooks
remove webhookdelete
update webhookpatch
add webhookpost
get allget

200The resulting Interaction record

401Authorization credentials were missing or invalid

403The user is authenticated, but is not allowed to perform the requested operation

404One of the records needed to complete the request could not be found

410The requested record no longer exists, or that API has been deprecated

429You have made too many requests to the given endpoint, please try again later

500An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com