Participant Service
Participant
Get list of participants of a participant type.
1min
GET
PATH PARAMETERS
participantTypePluralName
ParticipantTypePluralName
*A unique *plural name* i.e. a term that defines multiple participants of this participant type. This is used as collection name in resource URL for this participant type and as participant id prefix.
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*Unique requestId
X-COREOS-TID
string
*Tenant id
X-COREOS-ACCESS
string
*Unique core-os access token
X-COREOS-USERINFO
string
core-os user info
QUERY PARAMETERS
limit
integer
Number of items to return.
offset
integer
Number of items to skip from start.
size
integer
Number of items in a page.
page
integer
Page number to return(starting from 1)
select
string[]
Specifies list of attributes to be included in response (id is always included in response). If not specified, all attributes are included in response.
query
Query
sortBy
SortBy
ordering of data
sortKey
InstanceSortKey
key to be used for sorting data.
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
*Error Information
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
*Error Information
request
Request
*404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*Error Information
request
Request
*

Updated 24 Aug 2023
Did this page help you?