Own Credas? Customize your docs with AI search, analytics, and more.

GET

Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.

https://credas.co.uk/api/registrations/search

Access Token Required: API Key

Query Params

pageNumintegerDefault: 0

Zero-based page number to retrieve.

pageSizeintegerDefault: 50

Number of records to return on each request (Maximum value is 50).

forenamestring

Search by forename.

surnamestring

Search by surname.

emailstring

Search by user email.

dobstring

Date of birth in (yyyy-MM-dd) format

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://credas.co.uk/api/registrations/search' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.

https://credas.co.uk/api/registrations/search

Access Token Required: API Key

Query Params

pageNumintegerDefault: 0

Zero-based page number to retrieve.

pageSizeintegerDefault: 50

Number of records to return on each request (Maximum value is 50).

forenamestring

Search by forename.

surnamestring

Search by surname.

emailstring

Search by user email.

dobstring

Date of birth in (yyyy-MM-dd) format

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://credas.co.uk/api/registrations/search' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.

https://credas.co.uk/api/registrations/search

Access Token Required: API Key

Query Params

pageNumintegerDefault: 0

Zero-based page number to retrieve.

pageSizeintegerDefault: 50

Number of records to return on each request (Maximum value is 50).

forenamestring

Search by forename.

surnamestring

Search by surname.

emailstring

Search by user email.

dobstring

Date of birth in (yyyy-MM-dd) format

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://credas.co.uk/api/registrations/search' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Gets paged registration list by search criteria or nothing if there are no matching fields. Optional parameters may be appended to the query string. Maximum page size is 50.

https://credas.co.uk/api/registrations/search

Access Token Required: API Key

Query Params

pageNumintegerDefault: 0

Zero-based page number to retrieve.

pageSizeintegerDefault: 50

Number of records to return on each request (Maximum value is 50).

forenamestring

Search by forename.

surnamestring

Search by surname.

emailstring

Search by user email.

dobstring

Date of birth in (yyyy-MM-dd) format

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://credas.co.uk/api/registrations/search' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}