Client

Find clients on a workspace

Changed on
get/v1/workspaces/{workspaceId}/clients

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/clients
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Query parameters

namestring

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

Example:Client X
sort-columnstring

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

Example:NAME
sort-orderstring

Sorting mode

pageinteger

Page number.

Example:1
page-sizeinteger

Page size.

Example:50
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"
  }
]

Changes

  • a5b636acbcd8Revision changes
    • breaking

      for the query request parameter archived, default value was added

    • breaking

      for the query request parameter name, default value was added

    • breaking

      for the query request parameter sort-order, default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status