List Contacts

GET

https://getrasl.io/api/v1/{tenant-name}/contacts

Retrieve a paginated list of all contacts

You can filter and search contacts using various query parameters to find specific segments of your audience.

Use Cases

Browse all contacts in your database

Filter contacts by type (leads vs customers)

Find contacts from specific sources or with certain statuses

Implement pagination for large contact lists

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://getrasl.io/api/v1//contacts?type=lead&source_id=1&status_id=1&page=1&per_page=15' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

Example

{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "firstname": "Mahmoud",
        "lastname": "Elsayed",
        "company": "RASL",
        "type": "lead",
        "email": "mahmoud@example.com",
        "phone": "+201XXXXXXXXX",
        "source_id": 1,
        "status_id": 1,
        "description": "Interested in premium services",
        "country_id": 101,
        "group_id": [
          1,
          2
        ],
        "created_at": "2024-02-08T10:00:00.000000Z",
        "updated_at": "2024-02-08T10:00:00.000000Z"
      }
    ],
    "first_page_url": "https://getrasl.io/api/v1/tenantx/contacts?page=1",
    "from": 1,
    "last_page": 7,
    "last_page_url": "https://getrasl.io/api/v1/tenantx/contacts?page=7",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://getrasl.io/api/v1/tenantx/contacts?page=1",
        "label": "1",
        "active": true
      }
    ],
    "next_page_url": "https://getrasl.io/api/v1/tenantx/contacts?page=2",
    "path": "https://getrasl.io/api/v1/tenantx/contacts",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "total": 100
  }
}

🟠400Bad Request

🟠401Unauthenticated

Create a New Contact

Get Contact Details