Credential Offer Collections
Returns an array of credential offer collections in the environment.
Claim-based access control: Issuer_Admin
, Issuer_Auditor
, Issuer_User
Authorizations
Query parameters
pagenumberOptional
Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1
limitnumberOptional
Number of records per page. Example: 20 Default Value: 20 Max Value: 100
If provided value is greater than max value, max value will be applied.
filter.namestring[]Optional
Filter by name query param. Format: filter.name={$not}:OPERATION:VALUE Example: filter.name=$not:$like:John Doe&filter.name=like:John Available Operations$eq
Responses
200Success
application/json
Responseall of
and
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
get
GET /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-offer-collections HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-07-07T16:17:05.326Z",
"name": "text"
}
],
"meta": {
"select": [
"text"
],
"filter": {
"name": "text"
}
},
"links": {
"first": "text",
"previous": "text",
"current": "text",
"next": "text",
"last": "text"
}
}
Creates a new credential offer collection in the environment.
Claim-based access control: Issuer_Admin
, Issuer_User
Authorizations
Body
namestring · min: 1 · max: 50Required
Responses
201Success
application/json
400
Invalid request body
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
post
POST /products/web/$IDENTITY_ENV_ID/issuer/api/private/credential-offer-collections HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-07-07T16:17:05.326Z",
"name": "text"
}