API Reference

The Participant Kit API uses standard REST practices. Resource-orientated URLs, returns JSON encoded responses and uses standard HTTP response codes, authentication and verbs.

Authentication

All the API endpoints for Participant Kit require authentication. We allow the following methods

OAuth2 tokens
API keys (coming soon)

Oauth2 tokens

You can use the OAuth2 token by passing it in the header

Responses

We use conventional HTTP response codes to indicate the success or failure of an API request

2xx range indicates a success
4xx range indicates an an error that there was some missing provided information
5xx range means there is something wrong on our end

Common errors

400

This only usually happens on creating objects when a validation error is caused. Usually missing a required field

401

When an invalid key or token is provided

404

A 404 is caused when a missing resource is requested. For example when the resource with the requested id does not exist

Projects

project objects represent the projects that are within your organisation.

The project object

Attributes

id
string
Unique identifier for the object
object
string
Name of the object type
created_at
timestamp
When the object was created
updated_at
timestamp
When the object was last updated
app_url
string
The URL for the project within the Participant Kit App

Response

{
  "id": "proj_rNW9MurEP8gJ3S4cY2Lu7JH8",
  "object": "project",
  "name": "Project name",
  "created_at": "2021-01-18T10:06:30+00:00",
  "updated_at": "2021-01-18T10:06:30+00:00",
  "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8"
}

List all projects

Returns a list of all your organisations projects. Sorted by creation date.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1

Returns

A list object with a data property that contains an array of up to limit projects, using the page as a starting point. Each entry in the array is a separate project object. If no more project are available, the resulting array will be empty.

This request should never return an error.

GET /v1/projects

$ curl 'https://api.participantkit.com/v1/projects' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 99,
  "page": 1,
  "limit": 20,
  "total_pages": 5,
  "data": [
    {
      "id": "proj_rNW9MurEP8gJ3S4cY2Lu7JH8",
      "object": "project",
      "name": "Project name",
      "created_at": "2021-01-18T10:06:30+00:00",
      "updated_at": "2021-01-18T10:06:30+00:00",
      "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8"
    },
    {...},
    {...}
  ]
}

Retrieve a project

Retrieves the details for a project. You only need to supply the unique project identifier.

Parameters

None

Returns

Returns a project object if a valid identifier was provided.

GET /v1/projects/:id

$ curl 'https://api.participantkit.com/v1/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "proj_rNW9MurEP8gJ3S4cY2Lu7JH8",
  "object": "project",
  "name": "Project name",
  "created_at": "2021-01-18T10:06:30+00:00",
  "updated_at": "2021-01-18T10:06:30+00:00",
  "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8"
}

Panels

Panel objects represent the panels that are within your organisation.

The panel object

Attributes

id
string
Unique identifier for the object
object
string
Name of the object type. This will be "panel"
title
string
The title of the panel.
name
string
The internal name of the panel.
panellist_count
integer
The number of panellists subscribed to this panel.
created_at
timestamp
When the object was created
updated_at
timestamp
When the object was last updated

Response

{
  "id": "pan_Rn4kX7pQmW9vYtBcL2hZjA3s",
  "object": "panel",
  "title": "User Research Panel",
  "name": "user-research",
  "panellist_count": 42,
  "created_at": "2026-01-15T10:30:00.000Z",
  "updated_at": "2026-02-20T14:22:00.000Z"
}

List all panels

Returns a list of all your organisation's panels. Sorted by creation date.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1

Returns

A list object with a data property that contains an array of up to limit panels, using the page as a starting point. Each entry in the array is a separate panel object. If no more panel are available, the resulting array will be empty.

This request should never return an error.

GET /v1/panels

$ curl 'https://api.participantkit.com/v1/panels' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 2,
  "page": 1,
  "limit": 20,
  "total_pages": 1,
  "data": [
    {
      "id": "pan_Rn4kX7pQmW9vYtBcL2hZjA3s",
      "object": "panel",
      "title": "User Research Panel",
      "name": "user-research",
      "panellist_count": 42,
      "created_at": "2026-01-15T10:30:00.000Z",
      "updated_at": "2026-02-20T14:22:00.000Z"
    },
    {
      "id": "pan_Xyz789abc456def123ghi456",
      "object": "panel",
      "title": "Product Testing Panel",
      "name": "product-testing",
      "panellist_count": 28,
      "created_at": "2026-01-20T09:15:00.000Z",
      "updated_at": "2026-02-18T11:30:00.000Z"
    }
  ]
}

Retrieve a panel

Retrieves the details for a panel. Supply the unique panel identifier (starting with pan_).

Parameters

None

Returns

Returns a panel object if a valid identifier was provided.

GET /v1/panels/:id

$ curl 'https://api.participantkit.com/v1/panels/pan_Rn4kX7pQmW9vYtBcL2hZjA3s' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "pan_Rn4kX7pQmW9vYtBcL2hZjA3s",
  "object": "panel",
  "title": "User Research Panel",
  "name": "user-research",
  "panellist_count": 42,
  "created_at": "2026-01-15T10:30:00.000Z",
  "updated_at": "2026-02-20T14:22:00.000Z"
}

List panel panellists

Returns a list of subscribed panellists for a panel. Only includes panellists who have opted in and not opted out.

By default the response contains the panellist's id and the subscription lifecycle timestamps (opted_in_at, confirmed_at, opted_out_at) — enough to sort by recency, filter by confirmation state, or sync incrementally without holding personally identifying information. Use the include parameter to opt in to additional fields.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1
include
optional
Comma-separated list of additional data to include. pii adds the panellist's email and name. properties adds a properties array containing the panellist's custom field values scoped to this panel. Combine them as include=pii,properties.

Returns

A list object with a data property that contains an array of up to limit panellists, using the page as a starting point.

When include=properties is set, each panellist gains a properties array of { field_id, value } entries. field_id is a stable identifier you can join to the definitions returned by GET /v1/fields to interpret each value. Values for multiple_options fields are returned as arrays; all other datatypes return a string.

This request should never return an error.

GET /v1/panels/:id/panellists

$ curl 'https://api.participantkit.com/v1/panels/pan_Rn4kX7pQmW9vYtBcL2hZjA3s/panellists' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 42,
  "page": 1,
  "limit": 20,
  "total_pages": 3,
  "data": [
    {
      "id": "p_Abc123def456ghi789jkl012",
      "opted_in_at": "2026-03-12T09:15:00.000Z",
      "confirmed_at": "2026-03-12T09:18:42.000Z",
      "opted_out_at": null,
      "email": "jane@example.com", // include=pii
      "name": "Jane Smith" // include=pii
    },
    {
      "id": "p_Def456ghi789jkl012mno345",
      "opted_in_at": "2026-02-28T14:02:00.000Z",
      "confirmed_at": "2026-02-28T14:04:11.000Z",
      "opted_out_at": null,
      "email": "john@example.com", // include=pii
      "name": "John Doe" // include=pii
    }
  ]
}

GET /v1/panels/:id/panellists?include=pii

$ curl 'https://api.participantkit.com/v1/panels/pan_Rn4kX7pQmW9vYtBcL2hZjA3s/panellists?include=pii' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

GET /v1/panels/:id/panellists?include=properties

$ curl 'https://api.participantkit.com/v1/panels/pan_Rn4kX7pQmW9vYtBcL2hZjA3s/panellists?include=properties' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response (with properties)

{
  "object": "list",
  "count": 42,
  "page": 1,
  "limit": 20,
  "total_pages": 3,
  "data": [
    {
      "id": "p_Abc123def456ghi789jkl012",
      "opted_in_at": "2026-03-12T09:15:00.000Z",
      "confirmed_at": "2026-03-12T09:18:42.000Z",
      "opted_out_at": null,
      "email": "jane@example.com", // include=pii
      "name": "Jane Smith", // include=pii
      "properties": [
        { "field_id": "f_Eth123nic456ity789aBc012", "value": "white" },
        { "field_id": "f_Dob456ghi789jkl012mno345", "value": "1985-06-12" },
        { "field_id": "f_Hob789jkl012mno345pqr678", "value": ["Pottery", "Running"] }
      ]
    },
    {
      "id": "p_Def456ghi789jkl012mno345",
      "opted_in_at": "2026-02-28T14:02:00.000Z",
      "confirmed_at": "2026-02-28T14:04:11.000Z",
      "opted_out_at": null,
      "email": "john@example.com", // include=pii
      "name": "John Doe", // include=pii
      "properties": [
        { "field_id": "f_Eth123nic456ity789aBc012", "value": "asian" },
        { "field_id": "f_Dob456ghi789jkl012mno345", "value": "1992-11-03" },
        { "field_id": "f_Hob789jkl012mno345pqr678", "value": ["Reading", "Cooking"] }
      ]
    }
  ]
}

Studies

Study objects represent the research activities that are within your organisation.

The study object

Attributes

id
string
Unique identifier for the object
object
string
Name of the object type. This will be "study".
name
string
The name of the study.
start_date
date or null
The planned start date of the study.
end_date
date or null
The planned end date of the study.
tags
array of strings
Tag names applied to the study.
created_at
timestamp
When the object was created
updated_at
timestamp
When the object was last updated
app_url
string
The URL for the study within the Participant Kit App

Response

{
  "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
  "object": "study",
  "name": "Interview with customers",
  "start_date": "2026-04-15",
  "end_date": "2026-06-30",
  "tags": ["Longitudinal", "Phase 2"],
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
}

Create a study

Create a study within a project.

Parameters

project_id
required
The unique identifier for a project
name
required
The name for the new study

Returns

Returns the study object if the create succeeded. Returns an error if create parameters are invalid

POST /v1/studies

$ curl 'https://api.participantkit.com/v1/studies' \
    -X POST \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN' \
    -H "Content-Type: application/json" \
    -d '{
    "project_id": "proj_rNW9MurEP8gJ3S4cY2Lu7JH8",
    "name": "Interview with customers"
    }'

Response

{
  "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
  "object": "study",
  "name": "Interview with customers",
  "start_date": "2026-04-15",
  "end_date": "2026-06-30",
  "tags": ["Longitudinal", "Phase 2"],
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
}

List all studies

Returns a list of all your organisation's studies. Sorted by creation date.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1

Returns

A list object with a data property that contains an array of up to limit studys, using the page as a starting point. Each entry in the array is a separate study object. If no more study are available, the resulting array will be empty.

This request should never return an error.

GET /v1/studies

$ curl 'https://api.participantkit.com/v1/studies' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 99,
  "page": 1,
  "limit": 20,
  "total_pages": 5,
  "data": [
    {
      "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
      "object": "study",
      "name": "Interview with customers",
      "start_date": "2026-04-15",
      "end_date": "2026-06-30",
      "tags": ["Longitudinal", "Phase 2"],
      "created_at": "2026-02-16T10:29:30+00:00",
      "updated_at": "2026-02-16T10:29:30+00:00",
      "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
    },
    {...},
    {...}
  ]
}

Retrieve a study

Retrieves the details for a study. You only need to supply the unique study identifier.

Parameters

None

Returns

Returns a study object if a valid identifier was provided.

GET /v1/studies/:id

$ curl 'https://api.participantkit.com/v1/studies/sdy_8SaYJK8AgbpG6FXpddJgfsVM' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
  "object": "study",
  "name": "Interview with customers",
  "start_date": "2026-04-15",
  "end_date": "2026-06-30",
  "tags": ["Longitudinal", "Phase 2"],
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
}

Delete a study

Delete a study. You only need to supply the unique study identifier.

Parameters

None

Returns

Returns an object with a deleted parameter on success. If the study id does not exist, this call returns an error.

DELETE /v1/studies/:id

$ curl 'https://api.participantkit.com/v1/studies/sdy_8SaYJK8AgbpG6FXpddJgfsVM' \
    -X DELETE \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
  "object": "study",
  "deleted": true
}

Fields

Field objects describe the custom fields configured for your organisation. Use them to interpret the field_id values returned in panellist properties.

The field object

Attributes

id
string
Unique identifier for the field, prefixed with f_. Matches the field_id returned in panellist properties.
object
string
Name of the object type. This will be "field".
name
string
Machine-friendly identifier for the field, for example date_of_birth.
title
string
Human-readable label for the field, for example Date of birth.
datatype
string
The shape of the values stored against this field. One of string, text, telephone, number, single_option, multiple_options, datetime, or date.
options
array, optional
The list of allowed values for the field. Only present when datatype is single_option or multiple_options. Omitted for all other datatypes.

Response

{
  "id": "f_Eth123nic456ity789aBc012",
  "object": "field",
  "name": "ethnicity",
  "title": "Ethnicity",
  "datatype": "single_option",
  "options": ["asian", "black", "mixed", "white", "other"]
}

List all fields

Returns a list of all the custom field definitions configured for your organisation. Field definitions change infrequently, so we recommend fetching this list once, caching it, and resolving field_id values as you iterate panellists.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1

Returns

A list object with a data property that contains an array of up to limit fields, using the page as a starting point. Each entry in the array is a separate field object. If no more field are available, the resulting array will be empty.

This request should never return an error.

GET /v1/fields

$ curl 'https://api.participantkit.com/v1/fields' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 9,
  "page": 1,
  "limit": 20,
  "total_pages": 1,
  "data": [
    {
      "id": "f_Eth123nic456ity789aBc012",
      "object": "field",
      "name": "ethnicity",
      "title": "Ethnicity",
      "datatype": "single_option",
      "options": ["asian", "black", "mixed", "white", "other"]
    },
    {
      "id": "f_Dob456ghi789jkl012mno345",
      "object": "field",
      "name": "date_of_birth",
      "title": "Date of birth",
      "datatype": "date"
    },
    {
      "id": "f_Hob789jkl012mno345pqr678",
      "object": "field",
      "name": "hobbies",
      "title": "Hobbies",
      "datatype": "multiple_options",
      "options": ["Pottery", "Running", "Reading", "Cooking", "Gaming"]
    }
  ]
}

Participants

Participant objects represent the participants that are within your organisation.

By default the participant payload contains only non-identifying fields. Use include=pii on any of the read endpoints to also receive the participant's email and first_name.

The participant object

Attributes

id
string
Unique identifier for the object
object
string
Name of the object type. This will be "participant"
anonymous_id
string
A short, study-scoped identifier for the participant. Suitable for use as a human-friendly reference where personally identifying information is not required.
created_at
timestamp
When the object was created
updated_at
timestamp
When the object was last updated
app_url
string
The URL for the participant within the Participant Kit App
study
object
The study that the participant is taking part in.
first_name
string
The first name of the participant. Returned only when include=pii is requested.
email
string
The email of the participant. Returned only when include=pii is requested.

Response

{
  "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
  "object": "participant",
  "anonymous_id": "P1",
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
  "email": "test@example.com", // include=pii
  "first_name": "Alice", // include=pii
  "study": {
    "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
    "object": "study",
    "name": "Interview with customers",
    "start_date": "2026-04-15",
    "end_date": "2026-06-30",
    "tags": ["Longitudinal", "Phase 2"],
    "created_at": "2026-02-16T10:29:30+00:00",
    "updated_at": "2026-02-16T10:29:30+00:00",
    "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
  }
}

Create a participant

Creates a participant.

Parameters

name
required
The participants full name.
email
required
The participants email address. Used to send the consent remotely and for communications.
event_id
required
The unique identifier for the study that the participant is participating in.
include
optional
Pass pii to have the created participant's email and first_name returned in the response.

Returns

Returns the participant object if the create succeeded. Returns an error if create parameters are invalid

POST /v1/participants

$ curl 'https://api.participantkit.com/v1/participants' \
    -X POST \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN' \
    -H "Content-Type: application/json" \
    -d '{
    "name": "Alice Apple",
    "email": "test@example.com",
    "event_id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM"
    }'

Response

{
  "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
  "object": "participant",
  "anonymous_id": "P1",
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
  "email": "test@example.com", // include=pii
  "first_name": "Alice", // include=pii
  "study": {
    "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
    "object": "study",
    "name": "Interview with customers",
    "start_date": "2026-04-15",
    "end_date": "2026-06-30",
    "tags": ["Longitudinal", "Phase 2"],
    "created_at": "2026-02-16T10:29:30+00:00",
    "updated_at": "2026-02-16T10:29:30+00:00",
    "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
  }
}

List all participants

Returns a list of all your organisation's participants. Sorted by creation date.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1
include
optional
Pass pii to include email and first_name on each participant.

Returns

A list object with a data property that contains an array of up to limit participants, using the page as a starting point. Each entry in the array is a separate participant object. If no more participant are available, the resulting array will be empty.

This request should never return an error.

GET /v1/participants

$ curl 'https://api.participantkit.com/v1/participants' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 99,
  "page": 1,
  "limit": 20,
  "total_pages": 5,
  "data": [
    {
      "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
      "object": "participant",
      "anonymous_id": "P1",
      "created_at": "2026-02-16T10:29:30+00:00",
      "updated_at": "2026-02-16T10:29:30+00:00",
      "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
      "email": "test@example.com", // include=pii
      "first_name": "Alice", // include=pii
      "study": {
        "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
        "object": "study",
        "name": "Interview with customers",
        "start_date": "2026-04-15",
        "end_date": "2026-06-30",
        "tags": ["Longitudinal", "Phase 2"],
        "created_at": "2026-02-16T10:29:30+00:00",
        "updated_at": "2026-02-16T10:29:30+00:00",
        "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
      }
    },
    {...},
    {...}
  ]
}

GET /v1/participants?include=pii

$ curl 'https://api.participantkit.com/v1/participants?include=pii' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Retrieve a participant

Retrieves the details for a participant. You only need to supply the unique participant identifier.

Parameters

include
optional
Pass pii to include the participant's email and first_name.

Returns

Returns a participant object if a valid identifier was provided.

GET /v1/participants/:id

$ curl 'https://api.participantkit.com/v1/participants/par_TBuhrZgWc41kUa3gL6zxhJUq' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
  "object": "participant",
  "anonymous_id": "P1",
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
  "email": "test@example.com", // include=pii
  "first_name": "Alice", // include=pii
  "study": {
    "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
    "object": "study",
    "name": "Interview with customers",
    "start_date": "2026-04-15",
    "end_date": "2026-06-30",
    "tags": ["Longitudinal", "Phase 2"],
    "created_at": "2026-02-16T10:29:30+00:00",
    "updated_at": "2026-02-16T10:29:30+00:00",
    "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
  }
}

GET /v1/participants/:id?include=pii

$ curl 'https://api.participantkit.com/v1/participants/par_TBuhrZgWc41kUa3gL6zxhJUq?include=pii' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Consents

Consent objects represent the consents that are within your organisation.

Attributes

id
string
Unique identifier for the object
object
string
Name of the object type. This will be "consent"
created_at
timestamp
When the object was created
updated_at
timestamp
When the object was last updated
consented_at
timestamp
When the consent was given or refused
status
string
If the consent was given. One of agreed or refused
permissions
array
A list of strings which are the permissions that the participant has given
participant
object
The participant the consent is attached to

Response

{
  "id": "con_LZp1rZc9mGBirpdTosvbvuo3",
  "object": "consent",
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "consented_at": "2026-02-16T10:29:30+00:00",
  "status": "agreed",
  "permissions": ["I agree ...", "..."],
  "participant": {
    "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
    "object": "participant",
    "first_name": "Alice",
    "email": "test@example.com",
    "created_at": "2026-02-16T10:29:30+00:00",
    "updated_at": "2026-02-16T10:29:30+00:00",
    "anonymous_id": "P1",
    "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
    "event": {
      "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
      "object": "study",
      "name": "Interview with customers",
      "created_at": "2026-02-16T10:29:30+00:00",
      "updated_at": "2026-02-16T10:29:30+00:00",
      "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
    }
  }
}

Returns a list of all your organisations consents. Sorted by creation date.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1
status
optional
Filter the consents by the status. One of agreed or refused

Returns

A list object with a data property that contains an array of up to limit consents, using the page as a starting point. Each entry in the array is a separate consent object. If no more consent are available, the resulting array will be empty.

This request should never return an error.

GET /v1/consents

$ curl 'https://api.participantkit.com/v1/consents' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 99,
  "page": 1,
  "limit": 20,
  "total_pages": 5,
  "data": [
    {
      "id": "con_LZp1rZc9mGBirpdTosvbvuo3",
      "object": "consent",
      "created_at": "2026-02-16T10:29:30+00:00",
      "updated_at": "2026-02-16T10:29:30+00:00",
      "consented_at": "2026-02-16T10:29:30+00:00",
      "status": "agreed",
      "permissions": ["I agree ...", "..."],
      "participant": {
        "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
        "object": "participant",
        "first_name": "Alice",
        "email": "test@example.com",
        "created_at": "2026-02-16T10:29:30+00:00",
        "updated_at": "2026-02-16T10:29:30+00:00",
        "anonymous_id": "P1",
        "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
        "event": {
          "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
          "object": "study",
          "name": "Interview with customers",
          "created_at": "2026-02-16T10:29:30+00:00",
          "updated_at": "2026-02-16T10:29:30+00:00",
          "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
        }
      }
    },
    {...},
    {...}
  ]
}

Retrieves the details for a consent. You only need to supply the unique consent identifier.

Parameters

None

Returns

Returns a consent object if a valid identifier was provided.

GET /v1/consents/:id

$ curl 'https://api.participantkit.com/v1/consents/con_LZp1rZc9mGBirpdTosvbvuo3' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "con_LZp1rZc9mGBirpdTosvbvuo3",
  "object": "consent",
  "created_at": "2026-02-16T10:29:30+00:00",
  "updated_at": "2026-02-16T10:29:30+00:00",
  "consented_at": "2026-02-16T10:29:30+00:00",
  "status": "agreed",
  "permissions": ["I agree ...", "..."],
  "participant": {
    "id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
    "object": "participant",
    "first_name": "Alice",
    "email": "test@example.com",
    "created_at": "2026-02-16T10:29:30+00:00",
    "updated_at": "2026-02-16T10:29:30+00:00",
    "anonymous_id": "P1",
    "app_url": "/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM/participants/par_TBuhrZgWc41kUa3gL6zxhJUq",
    "event": {
      "id": "sdy_8SaYJK8AgbpG6FXpddJgfsVM",
      "object": "study",
      "name": "Interview with customers",
      "created_at": "2026-02-16T10:29:30+00:00",
      "updated_at": "2026-02-16T10:29:30+00:00",
      "app_url": "/projects/proj_rNW9MurEP8gJ3S4cY2Lu7JH8/events/sdy_8SaYJK8AgbpG6FXpddJgfsVM"
    }
  }
}

Data Links

To associate data with a participant you can create a DataLink

The data-link object

Attributes

id
string
Unique identifier for the object
object
string
Name of the object type. This will be "data_link"
title
string
Name or title of the data
url
string
An accessible url to the data
reminder_on
timestamp
If set, when a reminder to delete the data will be sent
created_at
timestamp
When the object was created
updated_at
timestamp
When the object was last updated
recorded_at
timestamp
When the data was collected or created

Response

{
  "id": "link_58cfjco9KcR3EeNjvjjFnoaE",
  "object": "data_link",
  "title": "Recording 0",
  "url": "https://example.com/2/0",
  "reminder_on": "2021-05-17",
  "created_at": "2021-02-16T10:29:30+00:00",
  "updated_at": "2021-02-16T10:29:30+00:00",
  "recorded_at": "2021-02-16"
}

Create a data link

Creates a data links.

Parameters

url
required
The url where the data is. Should be accessible to people in your organisation
recorded_at
required, date
The date the data was collected or created. This works with ISO 8601 format e.g. YYYY-MM-DD
participant_id
required
The unique identifier for the participant the data is being linked to
title
optional
The title or name of the data being linked

Returns

Returns the data link object if the create succeeded. Returns an error if create parameters are invalid

POST /v1/data-links

$ curl 'https://api.participantkit.com/v1/data-links' \
    -X POST \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN' \
    -H "Content-Type: application/json" \
    -d '{
    "url": "https://example.com/2/0",
    "recorded_at": "2021-04-04",
    "participant_id": "par_TBuhrZgWc41kUa3gL6zxhJUq",
    "title": "Interview with P1"
    }'

Response

{
  "object": "list",
  "count": 99,
  "page": 1,
  "limit": 20,
  "total_pages": 5,
  "data": [
    {
      "id": "link_58cfjco9KcR3EeNjvjjFnoaE",
      "object": "data_link",
      "title": "Recording 0",
      "url": "https://example.com/2/0",
      "reminder_on": "2021-05-17",
      "created_at": "2021-02-16T10:29:30+00:00",
      "updated_at": "2021-02-16T10:29:30+00:00",
      "recorded_at": "2021-02-16"
    },
    {...},
    {...}
  ]
}

List all data links

Returns a list of all your organisations data links. Sorted by creation date.

Parameters

limit
optional
A limit on the number of objects returned. Defaults to 20 and is capped at 100.
page
optional
Combined with a limit or the default to be able to paginate through all the objects, the default is 1

Returns

A list object with a data property that contains an array of up to limit data links, using the page as a starting point. Each entry in the array is a separate data link object. If no more data link are available, the resulting array will be empty.

This request should never return an error.

GET /v1/data-links

$ curl 'https://api.participantkit.com/v1/data-links' \
    -X GET \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "object": "list",
  "count": 99,
  "page": 1,
  "limit": 20,
  "total_pages": 5,
  "data": [
    {
      "id": "link_58cfjco9KcR3EeNjvjjFnoaE",
      "object": "data_link",
      "title": "Recording 0",
      "url": "https://example.com/2/0",
      "reminder_on": "2021-05-17",
      "created_at": "2021-02-16T10:29:30+00:00",
      "updated_at": "2021-02-16T10:29:30+00:00",
      "recorded_at": "2021-02-16"
    },
    {...},
    {...}
  ]
}

Delete a data-link

This deletes or unlinks data from a participant

Parameters

None

Returns

Returns an object with a deleted parameter on success. If the data link id does not exist, this call returns an error.

DELETE /v1/data-links/:id

$ curl 'https://api.participantkit.com/v1/data-links/link_58cfjco9KcR3EeNjvjjFnoaE' \
    -X DELETE \
    -H "Accept: application/json" \
    -H 'Authorization: Bearer TOKEN'

Response

{
  "id": "link_58cfjco9KcR3EeNjvjjFnoaE",
  "object": "data_link",
  "deleted": true
}