client

Retrieve clients list

get/clients/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesclient_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Limit result set. Example: 1.

offsetinteger

Return results starting at offset. Example: 10.

Response

Returns client list.

countinteger required

Count of client

nextstring uri nullable required

Next page from pagination

previousstring uri nullable required

Previous page from pagination

Example response

{
  "results": [
    {
      "id": 42,
      "first_name": "Joe",
      "last_name": "Parker",
      "email": "joe@angelcam.com",
      "phone": "+1 111 222 333",
      "invoice_to": "client",
      "limited_account": false,
      "allowed_access": true,
      "confiremd_at": null
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.