Skip to main content
GET
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://api.shingleai.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "company": "<string>",
      "jobTitle": "<string>",
      "picture": "<string>",
      "notes": "<string>",
      "title": "<string>",
      "name": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "data": {},
      "emails": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "email": "<string>",
          "label": "<string>",
          "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "data": {}
        }
      ],
      "phoneNumbers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "phoneNumber": "<string>",
          "countryCode": "<string>",
          "nationalNumber": "<string>",
          "label": "<string>",
          "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "data": {}
        }
      ],
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "country": "<string>",
          "label": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "data": {}
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication via Bearer token

Query Parameters

​
limit
number
default:10

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100
Example:

10

​
offset
number | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
sortOrder
enum<string>
default:desc

Sort order by creation date

Available options:
asc,
desc
Example:

"desc"

Response

List of contacts with pagination metadata

​
data
object[]
required
​
meta
object