GET /contacts

List Contacts

This endpoint allows you to list all Contacts.

Operation ID: getContacts

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

Query Parameters

Name	Type	Description
`limit` query	integer	Number of contacts per page (defaults to 25).
`page` query	integer	Page number for pagination (defaults to 1).
`expanded` query	string	Comma-separated list of relations to include in the response. Allowed values: locals, profile_picture, suppliers, user, extensions_permissions.
`sort` query	string	Sort results by one or more fields. Allowed fields: name, email. Use a comma-separated list for multiple sorts and prefix a field with "-" for descending order. The alias "sorts" is also supported.
`s_contact_id` query	integer	Filter by a specific contact ID.
`s_contact_id_in` query	string	Comma-separated list of contact IDs to include.
`s_contact_id_notin` query	string	Comma-separated list of contact IDs to exclude.
`s_email` query	string	Filter by the exact email address.
`s_email_like` query	string	Filter contacts whose email contains the provided value (case-insensitive).
`s_email_notin` query	string	Comma-separated list of email addresses to exclude.
`s_name` query	string	Filter by the exact contact name.
`s_name_like` query	string	Filter contacts whose name contains the provided value (case-insensitive).
`s_phone` query	string	Filter by the contact phone number.
`s_has_access` query	string	Filter by the has_access field (can be 1 or 0).
`s_is_direct_user` query	string	Filters only contacts who have access to the Direct portal.
`s_clients-client_id` query	integer	Filter contacts associated with the provided client ID.
`sc_has_email` query	string	Scope results to contacts that have a non-empty email address (flag parameter, any value).

Responses

data array<object>

id string required read-only

ID of the Contact

Example: 123

type string required read-only

Model type

contact

Example: contact

attributes object required

contact_id integer read-only

ID of the Contact

Example: 123

entity_id integer read-only

ID of the Entity

Example: 123

cellphone string

The cellphone number of the Contact

Example: 123456789

language string

The language of the Contact

Example: pt_br

email string | null

The email of the Contact

Example: foo@bar.com

full_name string

The full name of the Contact

Example: Jose Pinhal

phone string

The phone number of the Contact

Example: 123456789

is_direct_user boolean

Indicates whether the contact is a Direct user

Example:

has_access union

Indicates whether the contact has access to Direct

Example:

relationships object

The relationships of the Contact

suppliers object

The Suppliers associated to the Contact

clients object

The Clients associated to the Contact

extensionsPermissions object

The Extensions Permissions associated to the Contact

locals object

The Locations associated to the Contact

profilePicture object

The profile picture of the Contact

user object

The user associated to the Contact

meta object

custom_fields object | null

meta object

Meta model structure details

pagination object

total integer required

Total items.

Example: 1

count integer required

Total items returned for the current page.

Example: 1

per_page integer required

Maximum number of records per page.

Example: 1

current_page integer required

Number of the current page.

total_pages integer required

Number of the total pages.

links object

Requests that return multiple items include a `links` attribute, with links related to request's context.

self string required read-only

Current response link.

Example: /path?page=1

first string required read-only

Link to the first page result.

Example: /path?page=1

last string required read-only

Link to the previous page result.

Example: /path?page=1

next string read-only

Link to the next page result.

Example: /path?page=1

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info 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

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

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/contacts' \
  -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/contacts', {
  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/contacts');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/contacts',
    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": "contact",
        "attributes": {
            "contact_id": 123,
            "entity_id": 123,
            "cellphone": "123456789",
            "language": "pt_br",
            "email": "foo@bar.com",
            "full_name": "Jose Pinhal",
            "phone": "123456789",
            "is_direct_user": false,
            "has_access": false
        },
        "relationships": {
            "suppliers": {},
            "clients": {},
            "extensionsPermissions": {},
            "locals": {},
            "profilePicture": {},
            "user": {}
        },
        "meta": {
            "custom_fields": {}
        }
    },
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 1,
            "current_page": 0,
            "total_pages": 0
        }
    },
    "links": {
        "self": "/path?page=1",
        "first": "/path?page=1",
        "last": "/path?page=1",
        "next": "/path?page=1"
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "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"
    }
}