Skip to main content
GET
/
clients
/
{client_id}
Get the details of a client
curl --request GET \
  --url https://{your-workspace}.neetoinvoice.com/api/external/v1/clients/{client_id} \
  --header 'X-Api-Key: <x-api-key>'
{
  "client": {
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "internal_notes": "<string>",
    "currency": "<string>",
    "status": "active",
    "logo": "<unknown>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_invoice_due_in_days": 123,
    "include_hours_by_person_in_invoice": true,
    "secondary_name": "<string>",
    "last_invoice_interval": "<string>"
  },
  "recipients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "[email protected]",
      "deleted": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

​
client_id
string
required

Unique ID of the client for which you want to retrieve or update details. Refer to Getting the Client ID section for detailed instructions.

Response

200 - application/json

OK - Request succeeded

​
client
object
​
recipients
object[]