Clients

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

Attributes

  • id uuid

  • name string

  • description string

  • type integer

  • address1 string

  • address2 string

  • address3 string

  • address4 string

  • address5 string

Endpoints

List Clients

get /api/clients

Arguments

  • limit integer

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

  • offset integer

    Will return items, but only those after the integer amount.

  • orderBy string, array

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

  • countOnly boolean

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

  • name string

    Only return items that have the given name.

  • type integer

    Only return items that have the given type.

Request with curl
curl "http://[Your IP]/api/clients" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "clients": [{ "id": "4C2293F0-CD5B-4A50-AAAF-2D411368462C", "name": "sys", "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.

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