Get Practitioners

Returns a paginated list of HCP (Health Care Professional) practitioner types. Results can be filtered by a free-text search on practitioner name and sorted by name or id. Supports cursor-based pagination.

Endpoint

GET

https://lifeapi.pulsepoint.com/RestApi/v2/meta/practitioners

Query Parameters

Name	Data Type	Required	Default	Notes
search	string	no		Free-text search across practitioner type names
sort	ENUM string	no	id	Sort field. Valid values: `name`, `id`
limit	integer	no	50	Maximum number of results per page
cursor	string	no		Opaque pagination cursor. Pass the `next_cursor` value from a previous response to get the next page

Sample Request

GET https://lifeapi.pulsepoint.com/RestApi/v2/meta/practitioners?search=Physician&sort=name&limit=50

Response Field List

Name	Data Type	Notes
success	boolean	Returns `true` on a successful request
message	string	Human-readable result message
requestId	string	Unique identifier for the request
data	array of objects	List of practitioner type objects
data.id	integer	Practitioner type ID
data.name	string	Practitioner type name
pagination	object	Pagination metadata
pagination.limit	integer	The page size used for this response
pagination.total	integer	Total number of records matching the query
pagination.has_more	boolean	Whether additional pages of results exist
pagination.next_cursor	string	Opaque cursor to pass as the `cursor` query parameter to retrieve the next page
pagination.next_cursor_url	string	Full URL for the next page of results

Sample Response

{
  "success": true,
  "message": "Operation completed successfully",
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "data": [
    {
      "id": 1,
      "name": "Physician"
    }
  ],
  "pagination": {
    "limit": 50,
    "total": 120,
    "has_more": true,
    "next_cursor": "eyJpZCI6MTIzNDU2fQ",
    "next_cursor_url": "/RestApi/v2/meta/practitioners?cursor=eyJpZCI6MTIzNDU2fQ&limit=50"
  }
}

Errors

HTTP Status	Error	Description
400	Validation Error	Invalid query parameters. `sort` must be `name` or `id`. `limit` must be a valid integer
401	Unauthorized	Invalid or expired access token
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Unexpected server error