Get Clients

Retrieves a list of clients with optional filtering, sorting, and pagination.


Endpoint

GET /clients

Authentication

Required: Authorization header with valid token

Query Parameters

ParameterTypeRequiredDescriptionExample
sortBystringNoField to sort byupdatedAt
sortDirectionstringNoSort directionDESC
updatedAfterdate-timeNoFilter clients updated after this date2024-01-01T00:00:00Z
searchstringNoSearch term for client name/descriptionconstruction
partnerTypestringNoFilter by partner typeINDUSTRY
statusstringNoFilter by client statusACTIVE
pagenumberNoPage number (default: 1)1
limitnumberNoItems per page (default: 20)20

Response

Success (200)

{
  "content": [
    "ClientEntity"
  ],
  "total": "number"
}

Response Field Descriptions:

  • content - Array of contract objects (ClientEntity Schema
  • total - Total number of contracts matching the query criteria

Error (400)

GeneralErrorResponse Schema

Example Usage

curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/client-management/clients?partnerType=INDUSTRY&status=ACTIVE&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_TOKEN"