Get list of participants of a participant type.

1min
GET
https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}
API to get information of all participants of participant type specified by participantTypePluralName, based on the filters specified.
Path Parameters
participantTypePluralName
ParticipantTypePluralName
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
limit
integer
offset
integer
size
integer
page
integer
select
string[]
query
Query
sortBy
SortBy
sortKey
InstanceSortKey
Responses
200
OK - The request succeeded
ParticipantsResponse
data
object
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v2/participants/{participantTypePluralName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
// OK - The request succeeded 
{
  "data": {
    "meta": {
      "totalElements": ""
    },
    "participants": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK - The request succeeded 
{
  "data": {
    "meta": {
      "totalElements": ""
    },
    "participants": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 31 May 2024
Did this page help you?
Create a new participant
Get custom & core attribute values of a participant.