Skip to main content
GET
/
clients
Get clients
curl --request GET \
  --url https://api.projectcor.com/v1/clients \
  --header 'Authorization: Bearer <token>'
{
  "total": "<string>",
  "perPage": 123,
  "page": 123,
  "lastPage": 123,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "business_name": "<string>",
      "name_contact": "<string>",
      "last_name_contact": "<string>",
      "email_contact": "jsmith@example.com",
      "website": "<string>",
      "description": "<string>",
      "condition": "<string>",
      "phone": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
default:1

Page number (default: 1). Set to false to disable pagination.

perPage
integer
default:20

Number of items per page (default: 20).

filters
string

URL-encoded JSON object with filter criteria.

Response

200 - application/json

Paginated list of clients

Paginated response for clients list

total

Total number of clients

perPage
integer

Number of items per page

page
integer

Current page number

lastPage
integer

Last available page number

data
object[]

Array of clients for the current page