Search individual

Endpoint
#

URL

https://crm-api-test.10npay.com/api/v1/Individual/search

Method:POST

Description

This endpoint allows you to search for individuals based on specified filters and sort criteria.

Request #

Headers

  • accept: text/plain
  • Authorization: Bearer <your_access_token>
  • Content-Type: application/json-patch+json

Request Example:

{
	"filters": [
		{
			"columnName": "Email",
			"operator": 0,
			"value": "testemail@temp.bg"
		}
	],
	"sortings": [
		{
			"sortBy": "Email",
			"sortOrder": 1
		}
	],
	"pageNumber": 1,
	"pageSize": 10
}

Response #

200 Success #

Schema:

{
	"totalCount": "integer",
	"data": [
		{
			"id": "integer",
			"photo": "string (nullable)",
			"firstName": "string (nullable)",
			"lastName": "string (nullable)",
			"nonLatinFirstName": "string (nullable)",
			"nonLatinLastName": "string (nullable)",
			"email": "string (nullable)",
			"walletId": "string (nullable)",
			"walletBalance": "number (double, nullable)",
			"currency": "string (nullable)",
			"merchantId": "integer",
			"merchant": "string (nullable)",
			"merchantGroup": "string (nullable)",
			"merchantGroupId": "integer",
			"lastLogin": "string ($date-time)",
			"status": "integer",
			"createdTimeStamp": "string ($date-time)",
			"cbsOnboarded": "boolean",
			"cbsId": "string (nullable)",
			"cryptoCustomer": "boolean",
			"personalIdentificationNumber": "string (nullable)"
		}
	]
}

Response Example:

{
	"totalCount": 1,
	"data": [
		{
			"id": 123,
			"photo": null,
			"firstName": "Ivailo",
			"lastName": "Petkov",
			"nonLatinFirstName": null,
			"nonLatinLastName": null,
			"email": "ivailo.petkov@alaricsecurities.com",
			"walletId": "WALLET123",
			"walletBalance": 1000.0,
			"currency": "USD",
			"merchantId": 456,
			"merchant": "Alaric Securities",
			"merchantGroup": "Finance",
			"merchantGroupId": 789,
			"lastLogin": "2023-07-08T12:34:56Z",
			"status": 1,
			"createdTimeStamp": "2023-07-01T08:00:00Z",
			"cbsOnboarded": true,
			"cbsId": "CBS123",
			"cryptoCustomer": false,
			"personalIdentificationNumber": "123456789"
		}
	]
}

400 Bad Request #

Schema:

{
	"type": "string (nullable)",
	"title": "string (nullable)",
	"status": "integer (nullable)",
	"detail": "string (nullable)",
	"instance": "string (nullable)"
}


Response Example:

{
	"type": "https://crm-api-test.10npay.com/api/v1/Individual/search",
	"title": "One or more validation errors occurred.",
	"status": 400,
	"detail": "The Email field is required.",
	"instance": "/api/v1/Individual/search"
}

500 Internal Server Error

Schema:

{
	"type": "string (nullable)",
	"title": "string (nullable)",
	"status": "integer (nullable)",
	"detail": "string (nullable)",
	"instance": "string (nullable)"
}

Response Example:

{
	"type": "https://crm-api-test.10npay.com/api/v1/Individual/search",
	"title": "An unexpected error occurred.",
	"status": 500,
	"detail": "Internal Server Error",
	"instance": "/api/v1/Individual/search"
}

Snippet #

API Properties
Header parameters
Result of the call

Powered by BetterDocs