List Validation Requests
GET/v1/validation-requests
List Validation Requests
Request​
Query Parameters
status string
Possible values: [pending
, accepted
, rejected
]
Filter for status of Validation Request
Example: pending
query string
filter for name of ValidationRequest or assigned Organisation
sort string
Possible values: [id
, name
]
Field to sort by
Example: name
cursor string
A cursor that points to where to start the page
pageSize integer
Default value: 25
How many items per page, for pagination.
Responses​
- 200
- 400
- 401
- 403
Successfully listed Validation Requests
- application/json
- Schema
- Example (from schema)
Schema
data object[]
object string
totalResults integer
pageSize integer
_links object
current string
next string
prev string
{
"data": [
{
"id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Some charity",
"registryName": "National Charities Registry",
"registryId": "I34324",
"email": "test@percent.internal",
"addressLine1": "Testowa street 15",
"addressLine2": "Testowa street 22/15",
"city": "Katowice",
"postal": "44-100",
"state": "Silesia",
"website": "https://percent.internal",
"organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"countryCode": "POL",
"rejectionReasonCode": "other",
"usaGroupExempt": true,
"createdAt": "2020-10-13T17:46:54.000Z",
"deletedAt": "2020-10-13T17:46:54.000Z",
"acceptedAt": "2020-10-13T17:46:54.000Z",
"rejectedAt": "2020-10-13T17:46:54.000Z",
"documents": [
{
"id": "validationrequestdocument_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"url": "https://s3-eu-west-1.amazonaws.com/assets.poweredbypercent.com/document.docx",
"createdAt": "2024-03-08T11:45:00.828Z",
"deletedAt": "2024-03-08T11:45:00.828Z"
}
],
"organisationTypes": [
"social_impact"
],
"organisationName": "string"
}
],
"object": "validation_request",
"totalResults": 33,
"pageSize": 25,
"_links": {
"current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- IncorrectParams
- CursorError
Schema
error object
code string
title string
message string
reasons string[]nullable
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Error in cursor parameter
{
"error": {
"code": "pagination/cursor_error",
"title": "Bad request",
"message": "Unable to find the next page"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}
Loading...