Help Center

Blog

Rally Developer Docs

Home

API Reference

Webhooks

Support

Get all person properties in your workspace

The end of the current page of results. Use to fetch the next page

Whether there are additional pages of results

Whether the property is PHI (Protected health information)

Whether the property is PII (Personally Identifiable Information)

Whether the property is unique across all people. Maximum of 10 across a workspace

The order of the option. Sorted by this string value, ie: it can be a number

bearerAuth

Error response for a bad request with details on what was invalid

Introduction

Key definitions of the different objects within Rally

Definitions

Relationships

Person Opted Out

Person Import API Finished

Imports activities into your workspace. If you'd like access to this route, please reach out to your Customer Success rep.

Import activities

Returns a person by email if they exist. Deprecated, use `GET /people/{personId}/opted-out` instead to get their status

Returns a person in your workspace

This will in turn update their contact status. Deprecated, use `PUT /people/{personId}/opted-out` instead

Updates a person's opted out status

Deletes all data for a set of persons by email within 90 days. Deprecated, use `POST /people/delete` or `DELETE /people/{personId}` instead

Deletes people by email

Gets an import by id

Get paginated list of incentives

Gets all panels in your workspace. Filtering currently not supported

Get paginated list of panels

Search for people in your workspace. You can filter by studies, segments, and panels. Or just retrieve additional metadata about a list of person ids

Search for people


Internal properties are on the person object and custom properties can be specified either with the id of the property or an object that contains the name and property type. 
  If a property with that name already exists then it will be used with *no* modification, if it does not exist then then property will be created before the import begins.
  
WARNING: These are treated as a PUT, not a PATCH. If you include a property in one person record and not another then the one that is missing it will have it removed

Import people

Delete people

Delete a person

Pass either the person ID or email to get the opted out status

Get a person's opted out status by ID or email

Pass either the person ID or email to update the opted out status

Update a person's opted out status

Paginated list of population in your workspace

Create multiple new person properties

Delete person properties in bulk

Get a person property by ID

Update a person property by ID

Deletes a person property by ID

Gets all segments in your workspace. Filtering currently not supported

Paginated list of segments in your workspace

Create a new study in your workspace. This can only be a draft study, certain features not supported and require updating in the UI

Create a new study

Get paginated list of studies in your workspace.

Get a study by ID

Update a study in your workspace. All data returned from a GET on a study needs to be included or will be overwritten. Certain features not supported and require updating in the UI

Update a study

Update the status of a study in your workspace. This is the only way to programatically change a study's status

Update a study status

Get a paginated list of participants in a study. Filtering currently not supported

Paginated list of participants in a study

Import persons into a study. Supports all import properties within a person and also adds them as a participant. If the person is found then they are updated with any information included in here. 
Internal properties are on the person object and custom properties can be specified either with the id of the property or an object that contains the name and property type. 
  If a property with that name already exists then it will be used with *no* modification, if it does not exist then then property will be created before the import begins.
  
WARNING: These are treated as a PUT, not a PATCH. If you include a property in one person record and not another then the one that is missing it will have it removed

Backfills

Person

Imports

Incentives

Panels

People

Populations

Person Properties

Segments

Studies

Participants

Teams

Users

Get all person properties in your workspace

Authorizations

Query Parameters

Response