GET /clients

List all Clients

This endpoint allows you to get all Clients.

The query parameters described below are to be used with the JQL.

Operation ID: getClients

lock This endpoint requires a Bearer token in the Authorization header.

Query Parameters

Name	Type	Description
`code` query	string	Filter results by given property value
`name` query	string	Filter results by given property value
`client_id` query	integer	Filter results by given property value
`nif` query	string	Filter results by given property value
`sort` query	string	Field to sort by. Add `-` to sort descending. Supported values: - `name` - `code` - `nif` - `location` (sorts by city if present, else by country) Examples: - `order=name` (ascending) - `order=location-` (descending)

Responses

data array<object>

id string required read-only

ID of the Client

Example: 123

type string required read-only

Model type

client

Example: client

attributes object required

client_id integer

ID of the Client

Example: 123

client_uuid string (uuid)

UUID of the Client

Example: e632afe8-a1bf-4702-b5bd-b1163861ba51

name string

Client Name

Example: John Doe

code string | null

Client Code

Example: JD

nif string | null

NIF/ VAT Number of the Client

Example: 1234566789

postal_code string | null

Postal Code of the Client

Example: 1234-567

city string | null

City of the Client

Example: Lisbon

observations string | null

Additional information

Example: abc

address string | null

Address of the Client

Example: abc

country string | null

Country of the Client

Example: PT

created_at string (date-time) read-only

The datetime of the creation of the Client

Example: 2020-12-03T12:45:00

updated_at string (date-time) read-only

The datetime of the last update of the Client

Example: 2020-12-03T12:45:00

has_handshake boolean

Indicates if this Client is "connected" to work on Infraspeak Network.

Example: 1

my_company boolean

Indicates whether it is the entity's default client

Example: 1

relationships object

The relationships of the Client (Only present when expanded in the request)

buildings object

The Buildings associated to the Client

contacts object

The Contacts associated to the Client

files object

The Files associated to the Client

profilePicture object

The profile picture of the the Client

operators object

The Operators associated to the Client

handshake object

The Handshake associated to the Client

included array<union>

List of relationships to be included

id string read-only

ID of the Supplier

Example: 1

type string read-only

Model type

entity

attributes object

entity_id integer

name string

email string

site string

phone string

cellphone string

address string

nib string

nif string

report_email string

language string

currency string

license string

ASSISTANCE CHURNED COMPLEX CSENTITY DISTRIBUTED HOTEL NONE PARTNER PLACECHECKUP

profile_picture string

entity_uuid string

vat_rate number

colour string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

filter_alt Filters

Sort

Pagination

check entity

GET https://api.sandbox.infraspeak.com/v3/clients

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/clients' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/clients', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/clients');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/clients',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "123",
        "type": "client",
        "attributes": {
            "client_id": 123,
            "client_uuid": "e632afe8-a1bf-4702-b5bd-b1163861ba51",
            "name": "John Doe",
            "code": "JD",
            "nif": "1234566789",
            "postal_code": "1234-567",
            "city": "Lisbon",
            "observations": "abc",
            "address": "abc",
            "country": "PT",
            "created_at": "2020-12-03T12:45:00",
            "updated_at": "2020-12-03T12:45:00",
            "has_handshake": true,
            "my_company": true
        },
        "relationships": {
            "buildings": {},
            "contacts": {},
            "files": {},
            "profilePicture": {},
            "operators": {},
            "handshake": {}
        }
    },
    "included": {
        "id": "1",
        "type": "entity",
        "attributes": {
            "entity_id": 0,
            "name": "string",
            "email": "string",
            "site": "string",
            "phone": "string",
            "cellphone": "string",
            "address": "string",
            "nib": "string",
            "nif": "string",
            "report_email": "string",
            "language": "string",
            "currency": "string",
            "license": "ASSISTANCE",
            "profile_picture": "string",
            "entity_uuid": "string",
            "vat_rate": 0,
            "colour": "string"
        }
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}