Skip to main content
POST
/
v3
/
api
/
servicedesk
/
requests
List service requests
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/servicedesk/requests \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "productIds": [
    "0x0014"
  ],
  "serviceIds": [
    "0x0014-006"
  ],
  "requestTypes": [
    "CREATE"
  ],
  "requestIds": [
    "SERV-REQ-YTYTY676H"
  ],
  "endToEndIds": [
    "<uuid>"
  ],
  "statuses": [
    "PENDING AUTHORISATION"
  ],
  "modifiedAt": [
    "2025-05-06"
  ],
  "details": [
    "<string>"
  ],
  "entityIds": [
    "walletid or transfer id"
  ],
  "companyIds": [
    "ZTEST"
  ],
  "paginationLimit": 10,
  "paginationOffset": 123,
  "sort": {
    "by": "id",
    "order": "ASC"
  }
}
'
{
  "total": 123,
  "items": [
    {
      "requestId": "SERV-REQ-HGYT65YT",
      "serviceId": "0x0014-006",
      "product": "CUSTODY",
      "productId": "0x0014",
      "endToEndId": "<string>",
      "requestType": "uuid",
      "payload": {},
      "status": "PENDING CONFIRMATION",
      "companyId": "ZTEST",
      "businessObjects": {},
      "createdBy": "api-maker@zodia.io",
      "createdAt": "2025-05-27T09:54:03Z",
      "updatedBy": "api-maker@zodia.io",
      "updatedAt": "2025-05-27T09:54:03Z",
      "expiresAt": "2025-05-27T09:54:03Z",
      "entityId": "TRO-ZTEST-YTYTYU7687"
    }
  ]
}

Authorizations

X-Signature
string
header
required

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json
productIds
string[]
required

Search by product IDs

serviceIds
string[]
required

Search by service IDs

requestTypes
string[]

Search by request types i.e. CREATE, UPDATE, DEACTIVATE

requestIds
string[]

Search by request IDs

endToEndIds
string[]

Search by customer provided end to end IDs

statuses
string[]

Search by statuses. Refer to section Status Reference for the full list

modifiedAt
string[]
details
string[]
entityIds
string[]

Search by entity IDs. Possible values are wallet IDs, transactions IDs (not exhaustive)

companyIds
string[]
paginationLimit
integer<int32>

Number of items in response (default is 10)

Example:

10

paginationOffset
integer<int32>
sort
object

Response

OK

total
integer<int32>
items
object[]