Actionstep Participant Type Data Fields API
The Participant Type Data Fields API from Actionstep — 2 operation(s) for participant type data fields.
The Participant Type Data Fields API from Actionstep — 2 operation(s) for participant type data fields.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/actionstep-participant-type-data-fields-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Participant Type Data Fields API
description: Manages the collection of custom data fields for a participant type. For information on how to construct requests utilising fieldsets, sorting, paging, filters, and '*includes*', please refer to the API Developer Portal. E&OE.
version: '1.0'
tags:
- name: Participant Type Data Fields
paths:
/participanttypedatafields:
get:
description: Returns the collection of all participant type data fields.
tags:
- Participant Type Data Fields
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedParticipantTypeDataFields'
summary: Get participanttypedatafields
x-summary-source: derived
operationId: getParticipanttypedatafields
x-operation-id-source: derived
post:
description: Create a new participant type data field.
tags:
- Participant Type Data Fields
requestBody:
$ref: '#/components/requestBodies/CreateParticipantTypeDataField'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ParticipantTypeDataField'
summary: Create participanttypedatafields
x-summary-source: derived
operationId: postParticipanttypedatafields
x-operation-id-source: derived
/participanttypedatafields/{id}:
get:
description: Returns a single participant type data field record.
tags:
- Participant Type Data Fields
parameters:
- name: id
in: path
description: Unique identifier for a single participant type data field record.
required: true
schema:
type: integer
format: integer
example: 7384
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ParticipantTypeDataField'
summary: Get participanttypedatafields by id
x-summary-source: derived
operationId: getParticipanttypedatafieldsById
x-operation-id-source: derived
put:
description: Updates a single participant type data field record.
tags:
- Participant Type Data Fields
parameters:
- name: id
in: path
description: Unique identifier for a single participant type data field record.
required: true
schema:
type: integer
format: integer
example: 7384
requestBody:
$ref: '#/components/requestBodies/UpdateParticipantTypeDataField'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ParticipantTypeDataField'
summary: Replace participanttypedatafields by id
x-summary-source: derived
operationId: putParticipanttypedatafieldsById
x-operation-id-source: derived
delete:
description: Deletes a single participant type data field record.
tags:
- Participant Type Data Fields
parameters:
- name: id
in: path
description: Unique identifier for a single participant type data field record.
required: true
schema:
type: integer
format: integer
example: 7384
responses:
'204':
description: Success, No Content.
summary: Delete participanttypedatafields by id
x-summary-source: derived
operationId: deleteParticipanttypedatafieldsById
x-operation-id-source: derived
components:
schemas:
CreateParticipantTypeDataFieldLinks:
type: object
required:
- participantType
properties:
participantType:
description: Unique identifier for the underlying participant type.
example: 8263
type: integer
format: string
tag:
description: Unique identifier for a tag associated with the data field.
example: 392
type: integer
format: string
PagedParticipantTypeDataFields:
type: object
properties:
participanttypedatafields:
type: array
items:
$ref: '#/components/schemas/ParticipantTypeDataField'
meta:
$ref: '#/components/schemas/PageMetaData'
CreateParticipantTypeDataField:
type: object
required:
- name
- dataType
properties:
name:
description: Name of the participant type data field
type: string
format: string
example: Colours
dataType:
description: The data type for the participant type data field.
enum:
- Boolean
- Date
- DateNM
- DateTime
- DateTimeNM
- DropDown
- DropDownMulti
- Money
- Number
- Str255
- Str255Protected
- TextArea
default: Str255
type: string
format: string
example: Str255
label:
description: The label for the participant type data field.
type: string
format: string
example: Colour sample
formOrder:
description: The display order for the field when displayed on a user interface.
type: integer
format: string
example: 4
required:
description: Indicates if a value should be provided.
enum:
- T
- F
default: F
type: string
format: string
description:
description: A descriptor for the participant type data field.
type: string
format: string
example: Car colour
synchronizeValues:
description: When enabled (T) the field value is not unique to any specific Matter, meaning updating this field anywhere will update everywhere at the same time. When disabled (F) each Matter will have a unique value for this field.
enum:
- T
- F
default: F
type: string
format: string
limitUseToMatterOnly:
description: Enable this only if the field should not be editable on a contact record, but should be editable only on a contact linked to a matter.
enum:
- T
- F
default: F
type: string
format: string
links:
$ref: '#/components/schemas/CreateParticipantTypeDataFieldLinks'
UpdateParticipantTypeDataFieldLinks:
type: object
required:
- participantType
properties:
participantType:
description: Unique identifier for the underlying participant type.
example: 8263
type: integer
format: string
tag:
description: Unique identifier for a tag associated with the data field.
example: 392
type: integer
format: string
PagingData:
type: object
properties:
participanttypedatafields:
$ref: '#/components/schemas/ParticipantTypeDataFieldsPageData'
PageMetaData:
type: object
properties:
paging:
$ref: '#/components/schemas/PagingData'
ParticipantTypeDataField:
type: object
properties:
id:
description: Unique identifier for a single participant type data field record.
type: integer
format: integer
example: 7384
readOnly: true
name:
description: Name of the participant type data field
type: string
format: string
example: Colours
dataType:
description: The data type for the participant type data field.
enum:
- Boolean
- Date
- DateNM
- DateTime
- DateTimeNM
- DropDown
- DropDownMulti
- Money
- Number
- Str255
- Str255Protected
- TextArea
type: string
format: string
example: Str255
label:
description: The label for the participant type data field.
type: string
format: string
example: Colour sample
formOrder:
description: The display order for the field when displayed on a user interface.
type: integer
format: string
example: 4
required:
description: Indicates if a value should be provided.
enum:
- T
- F
default: F
type: string
format: string
description:
description: A descriptor for the participant type data field.
type: string
format: string
example: Car colour
synchronizeValues:
description: When enabled (T) the field value is not unique to any specific Matter, meaning updating this field anywhere will update everywhere at the same time. When disabled (F) each Matter will have a unique value for this field.
enum:
- T
- F
default: F
type: string
format: string
limitUseToMatterOnly:
description: Enable this only if the field should not be editable on a contact record, but should be editable only on a contact linked to a matter.
enum:
- T
- F
default: F
type: string
format: string
links:
$ref: '#/components/schemas/ParticipantTypeDataFieldLinks'
UpdateParticipantTypeDataField:
type: object
properties:
name:
description: Name of the participant type data field
type: string
format: string
example: Colours
label:
description: The label for the participant type data field.
type: string
format: string
example: Colour sample
formOrder:
description: The display order for the field when displayed on a user interface.
type: integer
format: string
example: 4
required:
description: Indicates if a value should be provided.
enum:
- T
- F
default: F
type: string
format: string
description:
description: A descriptor for the participant type data field.
type: string
format: string
example: Car colour
synchronizeValues:
description: When enabled (T) the field value is not unique to any specific Matter, meaning updating this field anywhere will update everywhere at the same time. When disabled (F) each Matter will have a unique value for this field.
enum:
- T
- F
default: F
type: string
format: string
limitUseToMatterOnly:
description: Enable this only if the field should not be editable on a contact record, but should be editable only on a contact linked to a matter.
enum:
- T
- F
default: F
type: string
format: string
links:
$ref: '#/components/schemas/UpdateParticipantTypeDataFieldLinks'
ParticipantTypeDataFieldsPageData:
type: object
properties:
recordCount:
description: The total number of participant type data field records returned by the underlying query.
type: integer
example: 2487
pageCount:
description: The total number of pages generated by the underlying query.
type: integer
example: 50
page:
description: The page number for this page of participant type data field records.
type: integer
example: 2
pageSize:
description: Page size.
type: integer
example: 50
prevPage:
description: A URL to the previous page of participant type data field records.
type: string
example: https://ap-southeast-2.actionstep.com/api/rest/participanttypedatafields?page=1
nextPage:
description: A URL to the next page of participant type data field records.
type: string
example: https://ap-southeast-2.actionstep.com/api/rest/participanttypedatafields?page=3
ParticipantTypeDataFieldLinks:
type: object
properties:
participantType:
description: Unique identifier for the underlying participant type.
example: 8263
type: integer
format: string
readOnly: true
tag:
description: Unique identifier for a tag associated with the data field.
example: 392
type: integer
format: string
readOnly: true
requestBodies:
CreateParticipantTypeDataField:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateParticipantTypeDataField'
UpdateParticipantTypeDataField:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateParticipantTypeDataField'