Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Client

Find clients on a workspace

get/v1/workspaces/{workspaceId}/clients

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

namestring

Filters client results that matches with the string provided in their client name.

Example:Client X

Filters client results that matches with the string provided in their client name.

sort-columnstring

Column name that will be used as criteria for sorting results.

Example:NAME

Column name that will be used as criteria for sorting results.

sort-orderstring

Sorting mode

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

archivedstring

Filter whether to include archived clients or not.

Response

OK

addressstring

Represents client's address.

archivedboolean

Represents whether a client is archived or not.

ccEmailsstring[]

Represents additional emails for sending invoices.

currencyCodestring

Represents client currency code.

currencyIdstring

Represents currency identifier across the system.

emailstring

Represents client email.

idstring

Represents client identifier across the system.

namestring

Represents client name.

notestring

Represents saved notes for the client.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "address": "Ground Floor, ABC Bldg., Palo Alto, California, USA 94020",
    "ccEmails": [
      "clientx@example.com"
    ],
    "currencyCode": "USD",
    "currencyId": "33t687e29ae1f428e7ebe505",
    "email": "clientx@example.com",
    "id": "44a687e29ae1f428e7ebe305",
    "name": "Client X",
    "note": "This is a sample note for the client.",
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]