Clients

A client is a group of people that own or access materials.

Attributes

  • name string

    The name of the client.

  • id uuid

    The unique identifier of the client.

  • description string

    The description of the client.

  • type integer

    The type of client configuration.

    Possible values:

    1 = Standalone (standard settings)
    2 = Standalone (custom settings)
    3 = Client Only
    4 = Rule Engine

  • address1 string

  • address2 string

  • address3 string

  • address4 string

  • address5 string

Endpoints

List Clients

get /api/clients

Get a list of clients from the PPG database. View the guide on adding filters to List API calls.

Arguments

  • type integer

    The type of client configuration.

    Possible values:

    1 = Standalone (standard settings)
    2 = Standalone (custom settings)
    3 = Client Only
    4 = Rule Engine

  • countOnly boolean

    When "true", will only return a count of the amount of items in the query.

    Default value: false

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000.

    Default value: 250

  • page integer

    Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.

  • orderBy string, array

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/clients" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "clients": [{ "name": " sys ", "id": " 4C2293F0-CD5B-4A50-AAAF-2D411368462C ", "description": " main ", "type": " 3 ", "address1": " string ", "address2": " string ", "address3": " string ", "address4": " string ", "address5": " string ", }] }] }

Show Client

get /api/clients/[id]

Get a single client from the PPG database and return a JSON response.

Arguments

  • id uuid

    Unique identifier for the client.

  • address1 String

    Primary address for client.

  • address2 String

  • address3 String

  • address4 String

  • address5 String

  • description String

  • name String

    Only return the name of the given client.

  • type Integer

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/clients/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "client": { "name": " sys " , "id": 4C2293F0-CD5B-4A50-AAAF-2D411368462C , "description": " main " , "type": 3 , "address1": " string " , "address2": " string " , "address3": " string " , "address4": " string " , "address5": " string " , } }