List and find contacts
Contacts of the workspace, newest first. Every member of the workspace may read them.
Filters combine: q searches name, e-mail, phone and identifier; phone matches the
number in any formatting; email matches regardless of case; identifier matches exactly.
Authorization
personalToken Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.
In: header
Query Parameters
Free text over name, e-mail, phone and identifier.
A phone number in any formatting — +7 (900) 123-45-67 finds +79001234567.
Only contacts with this label.
Page size, 1–100 (values outside are brought into that range). Not a number → 422 validation_failed.
251 <= value <= 100The next_cursor of the previous page. Opaque; a damaged cursor → 422 invalid_cursor.
Header Parameters
The workspace to work in (an id from GET /me). Optional when you belong to a single
workspace; required otherwise (400 workspace_required).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.lalexi.com/v1/contacts" \ -H "X-Workspace-Id: 7"{
"data": [
{
"id": 0,
"name": "string",
"phone": "string",
"email": "string",
"identifier": "string",
"social_profiles": {
"property1": "string",
"property2": "string"
},
"labels": [
"string"
],
"custom_attributes": {},
"blocked": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_activity_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string"
}{
"error": {
"code": "workspace_required",
"message": "You belong to several workspaces: pass the X-Workspace-Id header."
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is missing or invalid."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to do this."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found."
}
}{
"error": {
"code": "validation_failed",
"message": "The request is invalid.",
"details": {
"email": [
"is invalid"
]
}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the number of seconds in Retry-After."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side."
}
}