Clients

API Endpoints to access Clients

Get Client Details

• Endpoint: GET /clients/{client_id}

• Description: Retrieves the details of a specific client.

• Path Parameters:

  • client_id (integer, required): The unique identifier of the client.

• Response: 200 OK Returns a JSON object representing the client details.

Create Client

• Endpoint: POST /clients/

• Description: Creates a new client.

• Request Body:

  • title__-1 (string, required): The title of the client.

  • address__-3 (string, required): The address of the client.

  • accounttype__-29 (string, required): The account type of the client.

    • [residential, commercial]

  • primaryemail__-32 (string, required): The primary email of the client.

• Response: 201 CREATED Returns a JSON object representing the newly created client.

Note: The field names in the request body must match the api_name of the respective properties, which can be obtained using the "List Client Properties" endpoint.

List Clients

• Endpoint: GET /clients

• Description: Retrieves a list of clients with pagination.

• Query Parameters:

  • page (integer): The page number of the results.

  • page_size (integer): The number of clients per page.

• Response: 200 OK Returns a JSON array containing client objects.

List Client Properties

• Endpoint: GET /clients/properties

• Description: Retrieves a list of properties available for clients.

• Response: 200 OK Returns a JSON object containing an array of client properties.

Note: For properties of the person type, a user ID must be provided.